From c557a28a56eae5e60e6c3e738094f6b02d2e165b Mon Sep 17 00:00:00 2001 From: Phil Sturgeon Date: Tue, 13 Nov 2018 17:14:59 -0500 Subject: [PATCH 01/93] JsonApiParser is deprecated Their README says the project has been deprecated. They advertised jsonapi-rb / jsonapi-parser as a replacement, but that's more of a validator than a usable client-library, so I just deleted this entry. --- implementations/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/implementations/index.md b/implementations/index.md index 5d6ceeb4d..114cd7bce 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -65,7 +65,6 @@ isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and i * [jsonapi-consumer](https://github.com/jsmestad/jsonapi-consumer) a ruby library for consuming JSONAPI payloads. * [JsonApiClient](https://github.com/chingor13/json_api_client) attempts to give you a query building framework that is easy to understand (similar to ActiveRecord scopes). -* [JsonApiParser](https://github.com/beauby/jsonapi_parser) a ruby library for parsing/validating/handling JSONAPI documents. * [Munson](https://github.com/coryodaniel/munson) is a ruby JSONAPI client that can act as an ORM or integrate with your models via fine-grained agnosticism. Easy to configure and customize. Includes a chainable/customizable query builder, attributes API and dirty tracking. * [json-api-vanilla](https://github.com/trainline/json-api-vanilla) a reference-aware ruby library for JSONAPI deserialization that doesn't require setting up classes. * [SimpleJSONAPIClient](https://github.com/amcaplan/simple_jsonapi_client) gives you lower-level control for API operations, while your models and their relationships maintain a neat, ActiveRecord-inspired interface. From a883970db8155aee7ca9275714732df45107a348 Mon Sep 17 00:00:00 2001 From: Timothy Stone Date: Sun, 29 Aug 2021 14:43:21 -0400 Subject: [PATCH 02/93] Add Specification Numbering and build misc. (#1574) Citing the specification can be cumbersome. Following RFC numbering formats, the specification is numbered following ISO 2145 at each HEADER element, e.g., `h1`, `h2`, &tc. The numbers are CSS "generated" content and provide support for the additive focus of the specification. The paragraph glyph is repositioned absolutely, relative to the header. The `_config.yml` is updated to support building. `bundle` otherwise failed on Ruby 2.7.x. Updated the exclusions file for IntelliJ. --- .gitignore | 7 +++++++ _config.yml | 1 + stylesheets/all.css | 35 ++++++++++++++++++++++++----------- stylesheets/all.css.map | 4 ++-- stylesheets/all.sass | 25 +++++++++++++++++++++++-- 5 files changed, 57 insertions(+), 15 deletions(-) diff --git a/.gitignore b/.gitignore index d30e720ea..e369c5255 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,13 @@ Gemfile.lock # Ignore the build directory /public +# Ignore IntelliJ's config +*.iml +/.idea + +# Ignore Ruby vendor +/vendor + # Ignore Sass' cache /.sass-cache diff --git a/_config.yml b/_config.yml index d3c05f7a1..733972291 100644 --- a/_config.yml +++ b/_config.yml @@ -44,6 +44,7 @@ exclude: - .gitignore - ./public - ./stylesheets/*.scss + - vendor port: 9876 diff --git a/stylesheets/all.css b/stylesheets/all.css index cf272d6c9..efdde77ec 100644 --- a/stylesheets/all.css +++ b/stylesheets/all.css @@ -107,7 +107,8 @@ body { font-family: "Helvetica Neue", "Helvetica", Arial, "Open Sans", sans-serif; font-size: 15px; line-height: 1.6; - -webkit-font-smoothing: antialiased; } + -webkit-font-smoothing: antialiased; + counter-reset: h2counter; } /** Typography */ .headerlink { @@ -124,33 +125,49 @@ h1, h2, h3, h4, h5 { h1:hover .headerlink, h1 .headerlink:hover, h2:hover .headerlink, h2 .headerlink:hover, h3:hover .headerlink, h3 .headerlink:hover, h4:hover .headerlink, h4 .headerlink:hover, h5:hover .headerlink, h5 .headerlink:hover { font-size: inherit; } h1:hover .headerlink::after, h1 .headerlink:hover::after, h2:hover .headerlink::after, h2 .headerlink:hover::after, h3:hover .headerlink::after, h3 .headerlink:hover::after, h4:hover .headerlink::after, h4 .headerlink:hover::after, h5:hover .headerlink::after, h5 .headerlink:hover::after { - margin-left: -0.8em; - width: 0.8em; position: absolute; + left: 0; + width: 1em; content: "¶"; } h1 { font-weight: 500; - color: #0b4e22; } + color: #0b4e22; + counter-reset: h2counter; } h2 { margin: 2em 0 15px 0; color: #5a5a5a; font-size: 22px; - line-height: 1.3; } + line-height: 1.3; + counter-reset: h3counter; } + h2::before { + content: counter(h2counter) "  "; + counter-increment: h2counter; } h3 { margin: 30px 0 15px 0; - font-size: 18px; } + font-size: 18px; + counter-reset: h4counter; } + h3::before { + content: counter(h2counter) "." counter(h3counter) "  "; + counter-increment: h3counter; } h4 { margin: 20px 0 10px 0; - font-size: 16px; } + font-size: 16px; + counter-reset: h5counter; } + h4::before { + content: counter(h2counter) "." counter(h3counter) "." counter(h4counter) "  "; + counter-increment: h4counter; } h5 { margin: 20px 0 10px 0; font-weight: 500; font-size: inherit; } + h5::before { + content: counter(h2counter) "." counter(h3counter) "." counter(h4counter) "." counter(h5counter) "  "; + counter-increment: h5counter; } h5 code { font-weight: 600; } @@ -422,8 +439,4 @@ pre.highlight { .profile-page h1 + section h2 { margin-top: 1em; } -.profile-page .editor + .editor { - margin-top: 1em; -} - /*# sourceMappingURL=all.css.map */ diff --git a/stylesheets/all.css.map b/stylesheets/all.css.map index d7e0d24e7..093992985 100644 --- a/stylesheets/all.css.map +++ b/stylesheets/all.css.map @@ -1,7 +1,7 @@ { "version": 3, -"mappings": ";AAAA,QAAS;EACP,OAAO,EAAE,KAAK;EAAE,OAAO,EAAE,KAAK;EAC9B,KAAK,EAAE,IAAI;;AAGb,uHAAU;EACR,KAAK,EAAE,OAAO;;AAGhB,+CAAY;EACV,KAAK,EAAE,IAAI;;AAIX,sBAAS;EACP,KAAK,EAAE,IAAI;EACX,UAAU,EAAE,MAAM;;AAiBpB,qCAAkB;EAChB,WAAW,EAAE,IAAI;AAenB,sBAAa;EACX,KAAK,EAAE,IAAI;;AClDf,UASC;EARC,WAAW,EAAE,UAAU;EACvB,GAAG,EAAE,qCAAqC;EAC1C,GAAG,EAAE,sPAG4D;EACjE,WAAW,EAAE,MAAM;EACnB,UAAU,EAAE,MAAM;AAEpB,iGAAiG;AACjG,4FAA4F;AAC5F;;;;;;;EAOE;AAED,iDAAkD;EACjD,WAAW,EAAE,UAAU;EACvB,UAAU,EAAE,MAAM;EAClB,WAAW,EAAE,MAAM;EACnB,KAAK,EAAE,IAAI;EAEX,OAAO,EAAE,YAAY;EACrB,eAAe,EAAE,OAAO;EACxB,KAAK,EAAE,GAAG;EACV,UAAU,EAAE,MAAM;EAElB,iEAAiE;EACjE,YAAY,EAAE,MAAM;EACpB,cAAc,EAAE,IAAI;EAEpB,+CAA+C;EAC/C,WAAW,EAAE,GAAG;;AAGlB,mBAAoB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AACnD,iBAAkB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AACjD,mBAAoB;EAAE,OAAO,EAAE,OAAO;EAAE,SAAS,EAAE,IAAI;EAAE,QAAQ,EAAE,QAAQ;EAAE,GAAG,EAAE,KAAK;EAAE,IAAI,EAAE,KAAK;;AAAI,SAAS;AACjH,kBAAmB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AAClD,oBAAqB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;;;ACnBpD,uDAAU;EACR,OAAO,EAAE,KAAK;EACd,SAAS,EApBE,KAAK;EAqBhB,MAAM,EAAE,MAAM;EACd,OAAO,EAAE,MAAe;;AAE1B,0CAAoB;EAClB,UAAU,EAAE,OAAO;EAEnB,sDAAO;IACL,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,YAAY;IACrB,KAAK,EAAE,IAAI;;AAEf,gCAAW;EACT,cAAc,EAAE,SAAS;EACzB,cAAc,EAAE,KAAI;;AAItB,6CAAU;ECMN,WAAW,EAAE,SAA8C;EAC3D,QAAQ,EAAE,MAAM;EAChB,UAAU,EAAE,IAAI;EAShB,cAAc,EAAC,UAAU;;ADd7B,gCAAa;EEkCH,OAAO,EAAE,YAAyB;EAAlC,OAAO,EAAE,IAAyB;;AF9B5C,IAAI;EACF,WAAW,EAlCA,6DAA6D;EAmCxE,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;EAChB,sBAAsB,EAAE,WAAW;;;AAIrC,WAAW;EACT,eAAe,EAAE,IAAI;EACrB,KAAK,EA9CY,OAAkB;;AAgDrC,kBAAkB;EAChB,WAAW,EAAE,GAAG;EAChB,QAAQ,EAAE,QAAQ;EAClB,IAAI,EAAE,IAAI;EACV,YAAY,EAAE,GAAG;EAEjB,8EAAa;IACX,UAAU,EAAE,CAAC;EAEf,0NAAsC;IACpC,SAAS,EAAE,OAAO;IAClB,gSAAQ;MACN,WAAW,EAAE,MAAK;MAClB,KAAK,EAAE,KAAI;MACX,QAAQ,EAAE,QAAQ;MAClB,OAAO,EAAE,GAAG;;AAElB,EAAE;EACA,WAAW,EAAE,GAAG;EAChB,KAAK,EAtEQ,OAAe;;AAwE9B,EAAE;EACA,MAAM,EAAE,YAAuB;EAC/B,KAAK,EAzEM,OAAe;EA0E1B,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;;AAElB,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,SAAS,EAAE,IAAI;;AAEjB,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,SAAS,EAAE,IAAI;;AAEjB,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,WAAW,EAAE,GAAG;EAChB,SAAS,EAAE,OAAO;EAElB,OAAI;IACF,WAAW,EAAE,GAAG;;AAEpB,QAAQ;EACN,WAAW,EAAE,MAAM;EACnB,MAAM,EAAE,UAAU;;AAEpB,EAAE;EACA,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,GAAG;;AAEpB,CAAC;EACC,KAAK,EAtGM,OAAe;;AAwG5B,iBAAiB;EACf,MAAM,EAAE,MAAM;EACd,OAAO,EAAE,mBAAmB;EAC5B,aAAa,EArGM,GAAG;EAsGtB,KAAK,EAAE,IAAyB;EAChC,UAAU,EAAE,sBAAuB;EACnC,MAAM,EAAE,iBAA2B;EAEnC,2BAAI;IACF,UAAU,EAAE,kBAAkB;EAEhC,qBAAC;IACC,aAAa,EAAE,GAAG;EAEpB,2CAAY;IACV,aAAa,EAAE,CAAC;;AAEpB,mBAAmB;EACjB,OAAO,EAAE,OAAO;EAChB,UAAU,EAAE,mBAAmB;EAC/B,WAAW,EAAE,MAAM;;AAErB,IAAI;EACF,WAAW,EAAE,OAAO;;AAEtB,OAAO;EACL,UAAU,EAAE,MAAM;;;AAIpB,SAAS;EACP,WAAW,EAAE,GAAG;EAChB,UAAU,EAzIG,OAAe;EA0I5B,aAAa,EAAE,iBAA2B;EAK1C,YAAE;IGgMF,uBAAwC,EH9LrB,aAAa;IG8LhC,eAAwC,EH9LrB,aAAa;IAC9B,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,WAAW;IAEpB,oCAAiD;MAPnD,YAAE;QGgMF,sBAAwC,EHxLpB,MAAM;QGwL1B,cAAwC,EHxLpB,MAAM;QACtB,UAAU,EAAE,MAAM;EAEtB,YAAE;IGqLF,YAAwC,EHpLhC,QAAQ;IGoLhB,IAAwC,EHpLhC,QAAQ;EAEhB,WAAC;IACC,eAAe,EAAE,IAAI;IACrB,WAAW,EAAE,GAAG;IAChB,KAAK,EAAE,KAAK;IACZ,cAAc,EAAE,KAAI;EAGpB,mBAAC;IACC,WAAW,EAAE,GAAG;IAChB,cAAc,EAAE,KAAI;EAExB,wBAAc;IACZ,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,OAAO;IAChB,gBAAgB,EAAE,OAAyB;IAC3C,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,KAAK,EAAE,KAAK;IACZ,aAAa,EAxKI,GAAG;IAyKpB,QAAQ,EAAE,QAAQ;IAClB,GAAG,EAAE,IAAI;IAET,gCAAO;MAEL,cAAc,EAAE,kBAAkB;;;AAMtC,eAAQ;EACN,OAAO,EAAE,cAAuB;EAChC,UAAU,EAzLG,OAAkB;EA0L/B,aAAa,EAAE,iBAA2B;AAE5C,kBAAW;EAET,UAAU,EAAE,MAAM;EAClB,MAAM,EAAE,KAAK;EACb,MAAM,EAAE,CAAC;EACT,OAAO,EAAE,CAAC;EACV,IAAI,EAAE,IAAI;EACV,UAAU,EAAE,6CAA6C;EACzD,eAAe,EAAE,OAAO;AAE1B,SAAE;EACA,UAAU,EAAE,MAAM;EAClB,MAAM,EAAE,aAAa;EACrB,OAAO,EAAE,CAAC;EACV,IAAI,EAAE,CAAC;EACP,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,cAAc,EAAE,SAAS;AAE3B,kBAAW;EG4HX,mBAAwC,EHzHzB,MAAM;EGyHrB,WAAwC,EHzHzB,MAAM;EGyHrB,uBAAwC,EHxHrB,MAAM;EGwHzB,eAAwC,EHxHrB,MAAM;AAEzB,oBAAa;EACX,OAAO,EAAE,KAAK;EACd,MAAM,EAAE,QAAQ;EAChB,OAAO,EAAE,QAAQ;EACjB,aAAa,EAtNI,GAAG;EAuNpB,MAAM,EAAE,iBAAyB;EACjC,UAAU,EAAE,KAAK;EACjB,eAAe,EAAE,IAAI;EACrB,UAAU,EAAE,MAAM;AAEpB,oBAAa;EACX,MAAM,EAAE,WAAW;EACnB,SAAS,EAAE,IAAI;EACf,UAAU,EAAE,MAAM;EAClB,QAAQ,EAAE,QAAQ;EAClB,GAAG,EAAE,IAAI;EACT,KAAK,EAxOI,OAAe;EA0OxB,sBAAC;IACC,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,CAAC;AAEb,oCAAiD;EAC/C,eAAQ;IACN,WAAW,EAAE,IAAI;IACjB,cAAc,EAAE,IAAI;EAEtB,SAAE;IACA,MAAM,EAAE,gBAAgB;IACxB,SAAS,EAAE,IAAI;EAEjB,kBAAW;IGuFb,sBAAwC,EHtFpB,MAAM;IGsF1B,cAAwC,EHtFpB,MAAM;;;AAK5B,MAAM;EACJ,OAAO,EAAE,MAAuB;EAChC,UAAU,EAAE,MAAM;EAClB,SAAS,EAAE,IAAI;EACf,KAAK,EAjQM,OAAe;EAmQ1B,oBAAa;IACX,UAAU,EAAE,CAAC;IACb,aAAa,EAAE,CAAC;IAChB,WAAW,EAAE,CAAC;IAEd,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,iBAAyB;EAEvC,WAAI;IACF,OAAO,EAAE,YAAY;IACrB,cAAc,EAAE,MAAM;EAGtB,iBAAC;IACC,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,MAAK;EAElB,oBAAa;IAEX,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,QAAQ;IAClB,IAAI,EAAE,MAAK;IAEX,yBAAI;MAEF,KAAK,EAAE,CAAC;IAGV,sBAAC;MACC,KAAK,EAAE,GAAG;MACV,OAAO,EAAE,MAAK;MACd,OAAO,EAAE,YAAY;;;AAI3B,aAAa;EIxSX,QAAQ,EAAE,MAAM;ECiBd,KAAK,EAAE,CAAC;EL0RV,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,IAAI;;AAErB,QAAQ;EACN,KAAK,EAnTS,KAAK;EAoTnB,UAAU,EAAE,GAAG;EACf,KAAK,EAAE,IAAI;EAIX,WAAE;IACA,SAAS,EAAE,IAAI;IACf,gBAAgB,EAAE,KAAK;IACvB,OAAO,EAAE,CAAC;IACV,KAAK,EA7TO,KAAK;IA8TjB,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,GAAG;EAElB,iBAAQ;IACN,KAAK,EAlUO,KAAK;IAmUjB,UAAU,EAAE,IAAI;EAElB,gCAAuB;IACrB,KAAK,EAAE,KAAK;IACZ,aAAa,EAAE,IAAI;IACnB,OAAO,EAAE,IAAI;IACb,cAAc,EAAE,GAAG;IAEnB,sCAAK;MACH,OAAO,EAAE,IAAI;MACb,YAAY,EAAE,KAAI;IAEpB,gDAAe;MACb,cAAc,EAAE,GAAG;MACnB,SAAS,EAAE,CAAC;EAIhB,oCAAwE;IAnC1E,QAAQ;MA0CJ,KAAK,EAAE,IAAI;MACX,KAAK,EAAE,IAAI;MANX,4CAAmC;QACjC,OAAO,EAAE,IAAI;MAMf,YAAG;QACD,aAAa,EAAE,CAAC;MAIlB,gCAAuB;QACrB,KAAK,EAAE,IAAI;QACX,sCAAK;UACH,OAAO,EAAE,MAAM;;AAMvB,oCAAwE;EACtE,mBAAmB;IACjB,WAAW,EAAE,KAAqB;IAClC,YAAY,EAAE,mBAA0D;AAE5E,oCAAuE;EACrE,mBAAmB;IACjB,YAAY,EAAE,IAAI;;AAItB,iBAAiB;EACf,aAAa,EAAE,IAAI;EACnB,SAAS,EAAE,IAAI;EAEf,oBAAE;IACA,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;IAEV,0BAAK;MACH,OAAO,EAAE,UAAU;EAEvB,mBAAC;IACC,eAAe,EAAE,IAAI;IACrB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,KAAK;IAEd,yBAAO;MACL,KAAK,EAnYE,OAAe;;AAqY5B,2BAA2B;EACzB,OAAO,EAAE,SAAS;;;AAKpB,aAAa;EACX,aAAa,EAtYM,GAAG;EAuYtB,QAAQ,EAAE,QAAQ;EAClB,OAAO,EAAE,SAAS;EAClB,UAAU,EAAE,OAAO;EACnB,MAAM,EAAE,iBAAiB;EACzB,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,MAAM,EAAE,KAAK;EACb,WAAW,EAAE,gBAAgB;;;AAK7B,oCAAM;EACJ,OAAO,EAAE,MAAM;EACf,WAAW,EAAE,CAAC;AAEhB,wBAAS;EACP,OAAO,EAAE,KAAK;EACd,OAAO,EAAE,GAAG;EACZ,MAAM,EAAE,KAAI;AAEd,yBAAU;EACR,OAAO,EAAE,GAAO;EAChB,SAAS,EAAE,MAAM;EACjB,YAAY,EAAE,GAAG;EACjB,QAAQ,EAAE,QAAQ;EAClB,WAAW,EAAE,OAAM;EACnB,WAAW,EAAE,KAAK;;;AAMtB,gBAAgB;EACd,UAAU,EAxaI,GAAG;;AA0anB,6BAA6B;EAC3B,UAAU,EAAE,GAAG", -"sources": ["highlight.scss","fontello.scss","all.sass","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/typography/text/_replacement.scss","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/css3/_flexbox.scss","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/_support.scss","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/utilities/general/_clearfix.scss","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/utilities/general/_hacks.scss"], +"mappings": ";AAAA,QAAS;EACP,OAAO,EAAE,KAAK;EAAE,OAAO,EAAE,KAAK;EAC9B,KAAK,EAAE,IAAI;;AAGb,uHAAU;EACR,KAAK,EAAE,OAAO;;AAGhB,+CAAY;EACV,KAAK,EAAE,IAAI;;AAIX,sBAAS;EACP,KAAK,EAAE,IAAI;EACX,UAAU,EAAE,MAAM;;AAiBpB,qCAAkB;EAChB,WAAW,EAAE,IAAI;AAenB,sBAAa;EACX,KAAK,EAAE,IAAI;;AClDf,UASC;EARC,WAAW,EAAE,UAAU;EACvB,GAAG,EAAE,qCAAqC;EAC1C,GAAG,EAAE,sPAG4D;EACjE,WAAW,EAAE,MAAM;EACnB,UAAU,EAAE,MAAM;AAEpB,iGAAiG;AACjG,4FAA4F;AAC5F;;;;;;;EAOE;AAED,iDAAkD;EACjD,WAAW,EAAE,UAAU;EACvB,UAAU,EAAE,MAAM;EAClB,WAAW,EAAE,MAAM;EACnB,KAAK,EAAE,IAAI;EAEX,OAAO,EAAE,YAAY;EACrB,eAAe,EAAE,OAAO;EACxB,KAAK,EAAE,GAAG;EACV,UAAU,EAAE,MAAM;EAElB,iEAAiE;EACjE,YAAY,EAAE,MAAM;EACpB,cAAc,EAAE,IAAI;EAEpB,+CAA+C;EAC/C,WAAW,EAAE,GAAG;;AAGlB,mBAAoB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AACnD,iBAAkB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AACjD,mBAAoB;EAAE,OAAO,EAAE,OAAO;EAAE,SAAS,EAAE,IAAI;EAAE,QAAQ,EAAE,QAAQ;EAAE,GAAG,EAAE,KAAK;EAAE,IAAI,EAAE,KAAK;;AAAI,SAAS;AACjH,kBAAmB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AAClD,oBAAqB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;;;ACnBpD,uDAAU;EACR,OAAO,EAAE,KAAK;EACd,SAAS,EApBE,KAAK;EAqBhB,MAAM,EAAE,MAAM;EACd,OAAO,EAAE,MAAe;;AAE1B,0CAAoB;EAClB,UAAU,EAAE,OAAO;EAEnB,sDAAO;IACL,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,YAAY;IACrB,KAAK,EAAE,IAAI;;AAEf,gCAAW;EACT,cAAc,EAAE,SAAS;EACzB,cAAc,EAAE,KAAI;;AAItB,6CAAU;ECMN,WAAW,EAAE,SAA8C;EAC3D,QAAQ,EAAE,MAAM;EAChB,UAAU,EAAE,IAAI;EAShB,cAAc,EAAC,UAAU;;ADd7B,gCAAa;EEkCH,OAAO,EAAE,YAAyB;EAAlC,OAAO,EAAE,IAAyB;;AF9B5C,IAAI;EACF,WAAW,EAlCA,6DAA6D;EAmCxE,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;EAChB,sBAAsB,EAAE,WAAW;EACnC,aAAa,EAAE,SAAS;;;AAI1B,WAAW;EACT,eAAe,EAAE,IAAI;EACrB,KAAK,EA/CY,OAAkB;;AAiDrC,kBAAkB;EAChB,WAAW,EAAE,GAAG;EAChB,QAAQ,EAAE,QAAQ;EAClB,IAAI,EAAE,IAAI;EACV,YAAY,EAAE,GAAG;EAEjB,8EAAa;IACX,UAAU,EAAE,CAAC;EAEf,0NAAsC;IACpC,SAAS,EAAE,OAAO;IAClB,gSAAQ;MACN,QAAQ,EAAE,QAAQ;MAClB,IAAI,EAAE,CAAC;MACP,KAAK,EAAE,GAAG;MACV,OAAO,EAAE,GAAG;;AAElB,EAAE;EACA,WAAW,EAAE,GAAG;EAChB,KAAK,EAvEQ,OAAe;EAwE5B,aAAa,EAAE,SAAS;;AAE1B,EAAE;EACA,MAAM,EAAE,YAAuB;EAC/B,KAAK,EA3EM,OAAe;EA4E1B,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;EAChB,aAAa,EAAE,SAAS;EAExB,UAAS;IACP,OAAO,EAAE,uBAAmC;IAC5C,iBAAiB,EAAE,SAAS;;AAEhC,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,SAAS,EAAE,IAAI;EACf,aAAa,EAAE,SAAS;EAExB,UAAS;IACP,OAAO,EAAE,8CAA0D;IACnE,iBAAiB,EAAE,SAAS;;AAEhC,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,SAAS,EAAE,IAAI;EACf,aAAa,EAAE,SAAS;EAExB,UAAS;IACP,OAAO,EAAE,qEAAiF;IAC1F,iBAAiB,EAAE,SAAS;;AAEhC,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,WAAW,EAAE,GAAG;EAChB,SAAS,EAAE,OAAO;EAElB,UAAS;IACP,OAAO,EAAE,4FAAwG;IACjH,iBAAiB,EAAE,SAAS;EAE9B,OAAI;IACF,WAAW,EAAE,GAAG;;AAEpB,QAAQ;EACN,WAAW,EAAE,MAAM;EACnB,MAAM,EAAE,UAAU;;AAEpB,EAAE;EACA,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,GAAG;;AAEpB,CAAC;EACC,KAAK,EA3HM,OAAe;;AA6H5B,iBAAiB;EACf,MAAM,EAAE,MAAM;EACd,OAAO,EAAE,mBAAmB;EAC5B,aAAa,EA1HM,GAAG;EA2HtB,KAAK,EAAE,IAAyB;EAChC,UAAU,EAAE,sBAAuB;EACnC,MAAM,EAAE,iBAA2B;EAEnC,2BAAI;IACF,UAAU,EAAE,kBAAkB;EAEhC,qBAAC;IACC,aAAa,EAAE,GAAG;EAEpB,2CAAY;IACV,aAAa,EAAE,CAAC;;AAEpB,mBAAmB;EACjB,OAAO,EAAE,OAAO;EAChB,UAAU,EAAE,mBAAmB;EAC/B,WAAW,EAAE,MAAM;;AAErB,IAAI;EACF,WAAW,EAAE,OAAO;;AAEtB,OAAO;EACL,UAAU,EAAE,MAAM;;;AAIpB,SAAS;EACP,WAAW,EAAE,GAAG;EAChB,UAAU,EA9JG,OAAe;EA+J5B,aAAa,EAAE,iBAA2B;EAK1C,YAAE;IG2KF,uBAAwC,EHzKrB,aAAa;IGyKhC,eAAwC,EHzKrB,aAAa;IAC9B,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,WAAW;IAEpB,oCAAiD;MAPnD,YAAE;QG2KF,sBAAwC,EHnKpB,MAAM;QGmK1B,cAAwC,EHnKpB,MAAM;QACtB,UAAU,EAAE,MAAM;EAEtB,YAAE;IGgKF,YAAwC,EH/JhC,QAAQ;IG+JhB,IAAwC,EH/JhC,QAAQ;EAEhB,WAAC;IACC,eAAe,EAAE,IAAI;IACrB,WAAW,EAAE,GAAG;IAChB,KAAK,EAAE,KAAK;IACZ,cAAc,EAAE,KAAI;EAGpB,mBAAC;IACC,WAAW,EAAE,GAAG;IAChB,cAAc,EAAE,KAAI;EAExB,wBAAc;IACZ,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,OAAO;IAChB,gBAAgB,EAAE,OAAyB;IAC3C,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,KAAK,EAAE,KAAK;IACZ,aAAa,EA7LI,GAAG;IA8LpB,QAAQ,EAAE,QAAQ;IAClB,GAAG,EAAE,IAAI;IAET,gCAAO;MAEL,cAAc,EAAE,kBAAkB;;;AAMtC,eAAQ;EACN,OAAO,EAAE,cAAuB;EAChC,UAAU,EA9MG,OAAkB;EA+M/B,aAAa,EAAE,iBAA2B;AAE5C,kBAAW;EAET,UAAU,EAAE,MAAM;EAClB,MAAM,EAAE,KAAK;EACb,MAAM,EAAE,CAAC;EACT,OAAO,EAAE,CAAC;EACV,IAAI,EAAE,IAAI;EACV,UAAU,EAAE,6CAA6C;EACzD,eAAe,EAAE,OAAO;AAE1B,SAAE;EACA,UAAU,EAAE,MAAM;EAClB,MAAM,EAAE,aAAa;EACrB,OAAO,EAAE,CAAC;EACV,IAAI,EAAE,CAAC;EACP,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,cAAc,EAAE,SAAS;AAE3B,kBAAW;EGuGX,mBAAwC,EHpGzB,MAAM;EGoGrB,WAAwC,EHpGzB,MAAM;EGoGrB,uBAAwC,EHnGrB,MAAM;EGmGzB,eAAwC,EHnGrB,MAAM;AAEzB,oBAAa;EACX,OAAO,EAAE,KAAK;EACd,MAAM,EAAE,QAAQ;EAChB,OAAO,EAAE,QAAQ;EACjB,aAAa,EA3OI,GAAG;EA4OpB,MAAM,EAAE,iBAAyB;EACjC,UAAU,EAAE,KAAK;EACjB,eAAe,EAAE,IAAI;EACrB,UAAU,EAAE,MAAM;AAEpB,oBAAa;EACX,MAAM,EAAE,WAAW;EACnB,SAAS,EAAE,IAAI;EACf,UAAU,EAAE,MAAM;EAClB,QAAQ,EAAE,QAAQ;EAClB,GAAG,EAAE,IAAI;EACT,KAAK,EA7PI,OAAe;EA+PxB,sBAAC;IACC,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,CAAC;AAEb,oCAAiD;EAC/C,eAAQ;IACN,WAAW,EAAE,IAAI;IACjB,cAAc,EAAE,IAAI;EAEtB,SAAE;IACA,MAAM,EAAE,gBAAgB;IACxB,SAAS,EAAE,IAAI;EAEjB,kBAAW;IGkEb,sBAAwC,EHjEpB,MAAM;IGiE1B,cAAwC,EHjEpB,MAAM;;;AAK5B,MAAM;EACJ,OAAO,EAAE,MAAuB;EAChC,UAAU,EAAE,MAAM;EAClB,SAAS,EAAE,IAAI;EACf,KAAK,EAtRM,OAAe;EAwR1B,oBAAa;IACX,UAAU,EAAE,CAAC;IACb,aAAa,EAAE,CAAC;IAChB,WAAW,EAAE,CAAC;IAEd,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,iBAAyB;EAEvC,WAAI;IACF,OAAO,EAAE,YAAY;IACrB,cAAc,EAAE,MAAM;EAGtB,iBAAC;IACC,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,MAAK;EAElB,oBAAa;IAEX,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,QAAQ;IAClB,IAAI,EAAE,MAAK;IAEX,yBAAI;MAEF,KAAK,EAAE,CAAC;IAGV,sBAAC;MACC,KAAK,EAAE,GAAG;MACV,OAAO,EAAE,MAAK;MACd,OAAO,EAAE,YAAY;;;AAI3B,aAAa;EI7TX,QAAQ,EAAE,MAAM;ECiBd,KAAK,EAAE,CAAC;EL+SV,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,IAAI;;AAErB,QAAQ;EACN,KAAK,EAxUS,KAAK;EAyUnB,UAAU,EAAE,GAAG;EACf,KAAK,EAAE,IAAI;EAIX,WAAE;IACA,SAAS,EAAE,IAAI;IACf,gBAAgB,EAAE,KAAK;IACvB,OAAO,EAAE,CAAC;IACV,KAAK,EAlVO,KAAK;IAmVjB,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,GAAG;EAElB,iBAAQ;IACN,KAAK,EAvVO,KAAK;IAwVjB,UAAU,EAAE,IAAI;EAElB,gCAAuB;IACrB,KAAK,EAAE,KAAK;IACZ,aAAa,EAAE,IAAI;IACnB,OAAO,EAAE,IAAI;IACb,cAAc,EAAE,GAAG;IAEnB,sCAAK;MACH,OAAO,EAAE,IAAI;MACb,YAAY,EAAE,KAAI;IAEpB,gDAAe;MACb,cAAc,EAAE,GAAG;MACnB,SAAS,EAAE,CAAC;EAIhB,oCAAwE;IAnC1E,QAAQ;MA0CJ,KAAK,EAAE,IAAI;MACX,KAAK,EAAE,IAAI;MANX,4CAAmC;QACjC,OAAO,EAAE,IAAI;MAMf,YAAG;QACD,aAAa,EAAE,CAAC;MAIlB,gCAAuB;QACrB,KAAK,EAAE,IAAI;QACX,sCAAK;UACH,OAAO,EAAE,MAAM;;AAMvB,oCAAwE;EACtE,mBAAmB;IACjB,WAAW,EAAE,KAAqB;IAClC,YAAY,EAAE,mBAA0D;AAE5E,oCAAuE;EACrE,mBAAmB;IACjB,YAAY,EAAE,IAAI;;AAItB,iBAAiB;EACf,aAAa,EAAE,IAAI;EACnB,SAAS,EAAE,IAAI;EAEf,oBAAE;IACA,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;IAEV,0BAAK;MACH,OAAO,EAAE,UAAU;EAEvB,mBAAC;IACC,eAAe,EAAE,IAAI;IACrB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,KAAK;IAEd,yBAAO;MACL,KAAK,EAxZE,OAAe;;AA0Z5B,2BAA2B;EACzB,OAAO,EAAE,SAAS;;;AAKpB,aAAa;EACX,aAAa,EA3ZM,GAAG;EA4ZtB,QAAQ,EAAE,QAAQ;EAClB,OAAO,EAAE,SAAS;EAClB,UAAU,EAAE,OAAO;EACnB,MAAM,EAAE,iBAAiB;EACzB,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,MAAM,EAAE,KAAK;EACb,WAAW,EAAE,gBAAgB;;;AAK7B,oCAAM;EACJ,OAAO,EAAE,MAAM;EACf,WAAW,EAAE,CAAC;AAEhB,wBAAS;EACP,OAAO,EAAE,KAAK;EACd,OAAO,EAAE,GAAG;EACZ,MAAM,EAAE,KAAI;AAEd,yBAAU;EACR,OAAO,EAAE,GAAO;EAChB,SAAS,EAAE,MAAM;EACjB,YAAY,EAAE,GAAG;EACjB,QAAQ,EAAE,QAAQ;EAClB,WAAW,EAAE,OAAM;EACnB,WAAW,EAAE,KAAK;;;AAMtB,gBAAgB;EACd,UAAU,EA7bI,GAAG;;AA+bnB,6BAA6B;EAC3B,UAAU,EAAE,GAAG", +"sources": ["highlight.scss","fontello.scss","all.sass","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/typography/text/_replacement.scss","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/css3/_flexbox.scss","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/_support.scss","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/utilities/general/_clearfix.scss","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/utilities/general/_hacks.scss"], "names": [], "file": "all.css" } \ No newline at end of file diff --git a/stylesheets/all.sass b/stylesheets/all.sass index e142db93b..55874d293 100644 --- a/stylesheets/all.sass +++ b/stylesheets/all.sass @@ -55,6 +55,7 @@ body font-size: 15px line-height: 1.6 -webkit-font-smoothing: antialiased + counter-reset: h2counter /** Typography */ @@ -74,34 +75,54 @@ h1, h2, h3, h4, h5 &:hover .headerlink, .headerlink:hover font-size: inherit &::after - margin-left: -.8em - width: .8em position: absolute + left: 0 + width: 1em content: "¶" h1 font-weight: 500 color: $color-accent + counter-reset: h2counter h2 margin: $h2-margin-top 0 15px 0 color: $color-main font-size: 22px line-height: 1.3 + counter-reset: h3counter + + &::before + content: counter(h2counter) "\0000a0\0000a0" + counter-increment: h2counter h3 margin: 30px 0 15px 0 font-size: 18px + counter-reset: h4counter + + &::before + content: counter(h2counter) "." counter(h3counter) "\0000a0\0000a0" + counter-increment: h3counter h4 margin: 20px 0 10px 0 font-size: 16px + counter-reset: h5counter + + &::before + content: counter(h2counter) "." counter(h3counter) "." counter(h4counter) "\0000a0\0000a0" + counter-increment: h4counter h5 margin: 20px 0 10px 0 font-weight: 500 font-size: inherit + &::before + content: counter(h2counter) "." counter(h3counter) "." counter(h4counter) "." counter(h5counter) "\0000a0\0000a0" + counter-increment: h5counter + code font-weight: 600 From 9f2e7d833f9121893db3aa80f84f7fe440e2a5d8 Mon Sep 17 00:00:00 2001 From: Roger Meier Date: Sun, 29 Aug 2021 20:49:00 +0200 Subject: [PATCH 03/93] docs(implementations): remove jsonapi Django module (#1570) last commit on https://github.com/pavlov99/jsonapi is 5 years ago so I think this should not be listed --- implementations/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/implementations/index.md b/implementations/index.md index de14c4a35..6d84f76cc 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -246,7 +246,6 @@ the moment. * [Hyp](https://github.com/kalasjocke/hyp) is a library for creating json-api responses. * [SQLAlchemy-JSONAPI](https://github.com/coltonprovias/sqlalchemy-jsonapi) provides JSON:API serialization for SQLAlchemy models. * [django-rest-framework-json-api](https://github.com/django-json-api/django-rest-framework-json-api) provides JSON:API parsing and rendering for the Django REST Framework -* [jsonapi](https://github.com/pavlov99/jsonapi) is a Django module with JSON:API implementation. * [jsoongia](https://github.com/digia/jsoongia) is a framework agnostic JSON:API implementation. * [ripozo](https://github.com/vertical-knowledge/ripozo/) provides a framework for serving JSON:API content (among other Hypermedia formats) in Flask, Django and more. * [marshmallow-jsonapi](https://github.com/marshmallow-code/marshmallow-jsonapi) provides JSON:API data formatting for any Python web framework. From 096fc600494fb8ab24423abffaf3867e7ff711a1 Mon Sep 17 00:00:00 2001 From: markoilicic Date: Sun, 29 Aug 2021 20:49:18 +0200 Subject: [PATCH 04/93] Add Izzy JSONAPI parser Android in implementations (#1571) --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index 6d84f76cc..706179c42 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -117,6 +117,7 @@ isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and i * [faogustavo/JSONApi](https://github.com/faogustavo/JSONApi) library for deserializing automatic. It can be integrated with retrofit. It has some ideas from Morpheus and jsonapi-converter but has some aditionals. * [moshi-jsonapi](https://github.com/kamikat/moshi-jsonapi) serialize/deserialize JSON:API v1.0 using fantistic Moshi API! With friendly Java interface and easy integration with Retrofit. * [Morpheus](https://github.com/xamoom/Morpheus) library for deserializing your resources with automatic mapping for relationships. Uses gson to map objects in attributes. +* [Izzy JSONAPI parser](https://github.com/undabot/izzy-json-api-android) library for deserializing and serializing resources with support both for Gson and Jackson parsers. It also has simple Retrofit integration. ### R From e845eb3d49738c17f12929beb60c45f79bc4ae83 Mon Sep 17 00:00:00 2001 From: Julio Maniratunga <694912+julio73@users.noreply.github.com> Date: Sun, 29 Aug 2021 21:50:44 +0300 Subject: [PATCH 05/93] Fix typo with missing word (#1565) --- recommendations/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/recommendations/index.md b/recommendations/index.md index 4ffe4c5f5..1d52cf320 100644 --- a/recommendations/index.md +++ b/recommendations/index.md @@ -11,7 +11,7 @@ are beyond the scope of the base JSON:API specification. ## Naming The specification places certain [hard restrictions](http://jsonapi.org/format/#document-member-names) -on how members (i.e., keys) in a JSON:API document may named. To further +on how members (i.e., keys) in a JSON:API document may be named. To further standardize member names, which is especially important when mixing profiles authored by different parties, the following rules are also recommended: @@ -290,4 +290,4 @@ Every resource object **MUST** include a `timestamps` member in its associated The value of each member **MUST** comply with the variant of ISO 8601 used by JavaScript's `JSON.stringify` method to format Javascript `Date` objects. -``` \ No newline at end of file +``` From 759c1a4b8a9b9c3481c215f5332b51a46784f00a Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Mon, 30 Aug 2021 09:42:05 -0400 Subject: [PATCH 06/93] Revert "Add Specification Numbering and build misc. (#1574)" (#1579) This reverts commit a883970db8155aee7ca9275714732df45107a348. --- .gitignore | 7 ------- _config.yml | 1 - stylesheets/all.css | 35 +++++++++++------------------------ stylesheets/all.css.map | 4 ++-- stylesheets/all.sass | 25 ++----------------------- 5 files changed, 15 insertions(+), 57 deletions(-) diff --git a/.gitignore b/.gitignore index e369c5255..d30e720ea 100644 --- a/.gitignore +++ b/.gitignore @@ -12,13 +12,6 @@ Gemfile.lock # Ignore the build directory /public -# Ignore IntelliJ's config -*.iml -/.idea - -# Ignore Ruby vendor -/vendor - # Ignore Sass' cache /.sass-cache diff --git a/_config.yml b/_config.yml index 733972291..d3c05f7a1 100644 --- a/_config.yml +++ b/_config.yml @@ -44,7 +44,6 @@ exclude: - .gitignore - ./public - ./stylesheets/*.scss - - vendor port: 9876 diff --git a/stylesheets/all.css b/stylesheets/all.css index efdde77ec..cf272d6c9 100644 --- a/stylesheets/all.css +++ b/stylesheets/all.css @@ -107,8 +107,7 @@ body { font-family: "Helvetica Neue", "Helvetica", Arial, "Open Sans", sans-serif; font-size: 15px; line-height: 1.6; - -webkit-font-smoothing: antialiased; - counter-reset: h2counter; } + -webkit-font-smoothing: antialiased; } /** Typography */ .headerlink { @@ -125,49 +124,33 @@ h1, h2, h3, h4, h5 { h1:hover .headerlink, h1 .headerlink:hover, h2:hover .headerlink, h2 .headerlink:hover, h3:hover .headerlink, h3 .headerlink:hover, h4:hover .headerlink, h4 .headerlink:hover, h5:hover .headerlink, h5 .headerlink:hover { font-size: inherit; } h1:hover .headerlink::after, h1 .headerlink:hover::after, h2:hover .headerlink::after, h2 .headerlink:hover::after, h3:hover .headerlink::after, h3 .headerlink:hover::after, h4:hover .headerlink::after, h4 .headerlink:hover::after, h5:hover .headerlink::after, h5 .headerlink:hover::after { + margin-left: -0.8em; + width: 0.8em; position: absolute; - left: 0; - width: 1em; content: "¶"; } h1 { font-weight: 500; - color: #0b4e22; - counter-reset: h2counter; } + color: #0b4e22; } h2 { margin: 2em 0 15px 0; color: #5a5a5a; font-size: 22px; - line-height: 1.3; - counter-reset: h3counter; } - h2::before { - content: counter(h2counter) "  "; - counter-increment: h2counter; } + line-height: 1.3; } h3 { margin: 30px 0 15px 0; - font-size: 18px; - counter-reset: h4counter; } - h3::before { - content: counter(h2counter) "." counter(h3counter) "  "; - counter-increment: h3counter; } + font-size: 18px; } h4 { margin: 20px 0 10px 0; - font-size: 16px; - counter-reset: h5counter; } - h4::before { - content: counter(h2counter) "." counter(h3counter) "." counter(h4counter) "  "; - counter-increment: h4counter; } + font-size: 16px; } h5 { margin: 20px 0 10px 0; font-weight: 500; font-size: inherit; } - h5::before { - content: counter(h2counter) "." counter(h3counter) "." counter(h4counter) "." counter(h5counter) "  "; - counter-increment: h5counter; } h5 code { font-weight: 600; } @@ -439,4 +422,8 @@ pre.highlight { .profile-page h1 + section h2 { margin-top: 1em; } +.profile-page .editor + .editor { + margin-top: 1em; +} + /*# sourceMappingURL=all.css.map */ diff --git a/stylesheets/all.css.map b/stylesheets/all.css.map index 093992985..d7e0d24e7 100644 --- a/stylesheets/all.css.map +++ b/stylesheets/all.css.map @@ -1,7 +1,7 @@ { "version": 3, -"mappings": ";AAAA,QAAS;EACP,OAAO,EAAE,KAAK;EAAE,OAAO,EAAE,KAAK;EAC9B,KAAK,EAAE,IAAI;;AAGb,uHAAU;EACR,KAAK,EAAE,OAAO;;AAGhB,+CAAY;EACV,KAAK,EAAE,IAAI;;AAIX,sBAAS;EACP,KAAK,EAAE,IAAI;EACX,UAAU,EAAE,MAAM;;AAiBpB,qCAAkB;EAChB,WAAW,EAAE,IAAI;AAenB,sBAAa;EACX,KAAK,EAAE,IAAI;;AClDf,UASC;EARC,WAAW,EAAE,UAAU;EACvB,GAAG,EAAE,qCAAqC;EAC1C,GAAG,EAAE,sPAG4D;EACjE,WAAW,EAAE,MAAM;EACnB,UAAU,EAAE,MAAM;AAEpB,iGAAiG;AACjG,4FAA4F;AAC5F;;;;;;;EAOE;AAED,iDAAkD;EACjD,WAAW,EAAE,UAAU;EACvB,UAAU,EAAE,MAAM;EAClB,WAAW,EAAE,MAAM;EACnB,KAAK,EAAE,IAAI;EAEX,OAAO,EAAE,YAAY;EACrB,eAAe,EAAE,OAAO;EACxB,KAAK,EAAE,GAAG;EACV,UAAU,EAAE,MAAM;EAElB,iEAAiE;EACjE,YAAY,EAAE,MAAM;EACpB,cAAc,EAAE,IAAI;EAEpB,+CAA+C;EAC/C,WAAW,EAAE,GAAG;;AAGlB,mBAAoB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AACnD,iBAAkB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AACjD,mBAAoB;EAAE,OAAO,EAAE,OAAO;EAAE,SAAS,EAAE,IAAI;EAAE,QAAQ,EAAE,QAAQ;EAAE,GAAG,EAAE,KAAK;EAAE,IAAI,EAAE,KAAK;;AAAI,SAAS;AACjH,kBAAmB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AAClD,oBAAqB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;;;ACnBpD,uDAAU;EACR,OAAO,EAAE,KAAK;EACd,SAAS,EApBE,KAAK;EAqBhB,MAAM,EAAE,MAAM;EACd,OAAO,EAAE,MAAe;;AAE1B,0CAAoB;EAClB,UAAU,EAAE,OAAO;EAEnB,sDAAO;IACL,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,YAAY;IACrB,KAAK,EAAE,IAAI;;AAEf,gCAAW;EACT,cAAc,EAAE,SAAS;EACzB,cAAc,EAAE,KAAI;;AAItB,6CAAU;ECMN,WAAW,EAAE,SAA8C;EAC3D,QAAQ,EAAE,MAAM;EAChB,UAAU,EAAE,IAAI;EAShB,cAAc,EAAC,UAAU;;ADd7B,gCAAa;EEkCH,OAAO,EAAE,YAAyB;EAAlC,OAAO,EAAE,IAAyB;;AF9B5C,IAAI;EACF,WAAW,EAlCA,6DAA6D;EAmCxE,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;EAChB,sBAAsB,EAAE,WAAW;EACnC,aAAa,EAAE,SAAS;;;AAI1B,WAAW;EACT,eAAe,EAAE,IAAI;EACrB,KAAK,EA/CY,OAAkB;;AAiDrC,kBAAkB;EAChB,WAAW,EAAE,GAAG;EAChB,QAAQ,EAAE,QAAQ;EAClB,IAAI,EAAE,IAAI;EACV,YAAY,EAAE,GAAG;EAEjB,8EAAa;IACX,UAAU,EAAE,CAAC;EAEf,0NAAsC;IACpC,SAAS,EAAE,OAAO;IAClB,gSAAQ;MACN,QAAQ,EAAE,QAAQ;MAClB,IAAI,EAAE,CAAC;MACP,KAAK,EAAE,GAAG;MACV,OAAO,EAAE,GAAG;;AAElB,EAAE;EACA,WAAW,EAAE,GAAG;EAChB,KAAK,EAvEQ,OAAe;EAwE5B,aAAa,EAAE,SAAS;;AAE1B,EAAE;EACA,MAAM,EAAE,YAAuB;EAC/B,KAAK,EA3EM,OAAe;EA4E1B,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;EAChB,aAAa,EAAE,SAAS;EAExB,UAAS;IACP,OAAO,EAAE,uBAAmC;IAC5C,iBAAiB,EAAE,SAAS;;AAEhC,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,SAAS,EAAE,IAAI;EACf,aAAa,EAAE,SAAS;EAExB,UAAS;IACP,OAAO,EAAE,8CAA0D;IACnE,iBAAiB,EAAE,SAAS;;AAEhC,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,SAAS,EAAE,IAAI;EACf,aAAa,EAAE,SAAS;EAExB,UAAS;IACP,OAAO,EAAE,qEAAiF;IAC1F,iBAAiB,EAAE,SAAS;;AAEhC,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,WAAW,EAAE,GAAG;EAChB,SAAS,EAAE,OAAO;EAElB,UAAS;IACP,OAAO,EAAE,4FAAwG;IACjH,iBAAiB,EAAE,SAAS;EAE9B,OAAI;IACF,WAAW,EAAE,GAAG;;AAEpB,QAAQ;EACN,WAAW,EAAE,MAAM;EACnB,MAAM,EAAE,UAAU;;AAEpB,EAAE;EACA,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,GAAG;;AAEpB,CAAC;EACC,KAAK,EA3HM,OAAe;;AA6H5B,iBAAiB;EACf,MAAM,EAAE,MAAM;EACd,OAAO,EAAE,mBAAmB;EAC5B,aAAa,EA1HM,GAAG;EA2HtB,KAAK,EAAE,IAAyB;EAChC,UAAU,EAAE,sBAAuB;EACnC,MAAM,EAAE,iBAA2B;EAEnC,2BAAI;IACF,UAAU,EAAE,kBAAkB;EAEhC,qBAAC;IACC,aAAa,EAAE,GAAG;EAEpB,2CAAY;IACV,aAAa,EAAE,CAAC;;AAEpB,mBAAmB;EACjB,OAAO,EAAE,OAAO;EAChB,UAAU,EAAE,mBAAmB;EAC/B,WAAW,EAAE,MAAM;;AAErB,IAAI;EACF,WAAW,EAAE,OAAO;;AAEtB,OAAO;EACL,UAAU,EAAE,MAAM;;;AAIpB,SAAS;EACP,WAAW,EAAE,GAAG;EAChB,UAAU,EA9JG,OAAe;EA+J5B,aAAa,EAAE,iBAA2B;EAK1C,YAAE;IG2KF,uBAAwC,EHzKrB,aAAa;IGyKhC,eAAwC,EHzKrB,aAAa;IAC9B,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,WAAW;IAEpB,oCAAiD;MAPnD,YAAE;QG2KF,sBAAwC,EHnKpB,MAAM;QGmK1B,cAAwC,EHnKpB,MAAM;QACtB,UAAU,EAAE,MAAM;EAEtB,YAAE;IGgKF,YAAwC,EH/JhC,QAAQ;IG+JhB,IAAwC,EH/JhC,QAAQ;EAEhB,WAAC;IACC,eAAe,EAAE,IAAI;IACrB,WAAW,EAAE,GAAG;IAChB,KAAK,EAAE,KAAK;IACZ,cAAc,EAAE,KAAI;EAGpB,mBAAC;IACC,WAAW,EAAE,GAAG;IAChB,cAAc,EAAE,KAAI;EAExB,wBAAc;IACZ,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,OAAO;IAChB,gBAAgB,EAAE,OAAyB;IAC3C,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,KAAK,EAAE,KAAK;IACZ,aAAa,EA7LI,GAAG;IA8LpB,QAAQ,EAAE,QAAQ;IAClB,GAAG,EAAE,IAAI;IAET,gCAAO;MAEL,cAAc,EAAE,kBAAkB;;;AAMtC,eAAQ;EACN,OAAO,EAAE,cAAuB;EAChC,UAAU,EA9MG,OAAkB;EA+M/B,aAAa,EAAE,iBAA2B;AAE5C,kBAAW;EAET,UAAU,EAAE,MAAM;EAClB,MAAM,EAAE,KAAK;EACb,MAAM,EAAE,CAAC;EACT,OAAO,EAAE,CAAC;EACV,IAAI,EAAE,IAAI;EACV,UAAU,EAAE,6CAA6C;EACzD,eAAe,EAAE,OAAO;AAE1B,SAAE;EACA,UAAU,EAAE,MAAM;EAClB,MAAM,EAAE,aAAa;EACrB,OAAO,EAAE,CAAC;EACV,IAAI,EAAE,CAAC;EACP,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,cAAc,EAAE,SAAS;AAE3B,kBAAW;EGuGX,mBAAwC,EHpGzB,MAAM;EGoGrB,WAAwC,EHpGzB,MAAM;EGoGrB,uBAAwC,EHnGrB,MAAM;EGmGzB,eAAwC,EHnGrB,MAAM;AAEzB,oBAAa;EACX,OAAO,EAAE,KAAK;EACd,MAAM,EAAE,QAAQ;EAChB,OAAO,EAAE,QAAQ;EACjB,aAAa,EA3OI,GAAG;EA4OpB,MAAM,EAAE,iBAAyB;EACjC,UAAU,EAAE,KAAK;EACjB,eAAe,EAAE,IAAI;EACrB,UAAU,EAAE,MAAM;AAEpB,oBAAa;EACX,MAAM,EAAE,WAAW;EACnB,SAAS,EAAE,IAAI;EACf,UAAU,EAAE,MAAM;EAClB,QAAQ,EAAE,QAAQ;EAClB,GAAG,EAAE,IAAI;EACT,KAAK,EA7PI,OAAe;EA+PxB,sBAAC;IACC,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,CAAC;AAEb,oCAAiD;EAC/C,eAAQ;IACN,WAAW,EAAE,IAAI;IACjB,cAAc,EAAE,IAAI;EAEtB,SAAE;IACA,MAAM,EAAE,gBAAgB;IACxB,SAAS,EAAE,IAAI;EAEjB,kBAAW;IGkEb,sBAAwC,EHjEpB,MAAM;IGiE1B,cAAwC,EHjEpB,MAAM;;;AAK5B,MAAM;EACJ,OAAO,EAAE,MAAuB;EAChC,UAAU,EAAE,MAAM;EAClB,SAAS,EAAE,IAAI;EACf,KAAK,EAtRM,OAAe;EAwR1B,oBAAa;IACX,UAAU,EAAE,CAAC;IACb,aAAa,EAAE,CAAC;IAChB,WAAW,EAAE,CAAC;IAEd,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,iBAAyB;EAEvC,WAAI;IACF,OAAO,EAAE,YAAY;IACrB,cAAc,EAAE,MAAM;EAGtB,iBAAC;IACC,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,MAAK;EAElB,oBAAa;IAEX,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,QAAQ;IAClB,IAAI,EAAE,MAAK;IAEX,yBAAI;MAEF,KAAK,EAAE,CAAC;IAGV,sBAAC;MACC,KAAK,EAAE,GAAG;MACV,OAAO,EAAE,MAAK;MACd,OAAO,EAAE,YAAY;;;AAI3B,aAAa;EI7TX,QAAQ,EAAE,MAAM;ECiBd,KAAK,EAAE,CAAC;EL+SV,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,IAAI;;AAErB,QAAQ;EACN,KAAK,EAxUS,KAAK;EAyUnB,UAAU,EAAE,GAAG;EACf,KAAK,EAAE,IAAI;EAIX,WAAE;IACA,SAAS,EAAE,IAAI;IACf,gBAAgB,EAAE,KAAK;IACvB,OAAO,EAAE,CAAC;IACV,KAAK,EAlVO,KAAK;IAmVjB,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,GAAG;EAElB,iBAAQ;IACN,KAAK,EAvVO,KAAK;IAwVjB,UAAU,EAAE,IAAI;EAElB,gCAAuB;IACrB,KAAK,EAAE,KAAK;IACZ,aAAa,EAAE,IAAI;IACnB,OAAO,EAAE,IAAI;IACb,cAAc,EAAE,GAAG;IAEnB,sCAAK;MACH,OAAO,EAAE,IAAI;MACb,YAAY,EAAE,KAAI;IAEpB,gDAAe;MACb,cAAc,EAAE,GAAG;MACnB,SAAS,EAAE,CAAC;EAIhB,oCAAwE;IAnC1E,QAAQ;MA0CJ,KAAK,EAAE,IAAI;MACX,KAAK,EAAE,IAAI;MANX,4CAAmC;QACjC,OAAO,EAAE,IAAI;MAMf,YAAG;QACD,aAAa,EAAE,CAAC;MAIlB,gCAAuB;QACrB,KAAK,EAAE,IAAI;QACX,sCAAK;UACH,OAAO,EAAE,MAAM;;AAMvB,oCAAwE;EACtE,mBAAmB;IACjB,WAAW,EAAE,KAAqB;IAClC,YAAY,EAAE,mBAA0D;AAE5E,oCAAuE;EACrE,mBAAmB;IACjB,YAAY,EAAE,IAAI;;AAItB,iBAAiB;EACf,aAAa,EAAE,IAAI;EACnB,SAAS,EAAE,IAAI;EAEf,oBAAE;IACA,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;IAEV,0BAAK;MACH,OAAO,EAAE,UAAU;EAEvB,mBAAC;IACC,eAAe,EAAE,IAAI;IACrB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,KAAK;IAEd,yBAAO;MACL,KAAK,EAxZE,OAAe;;AA0Z5B,2BAA2B;EACzB,OAAO,EAAE,SAAS;;;AAKpB,aAAa;EACX,aAAa,EA3ZM,GAAG;EA4ZtB,QAAQ,EAAE,QAAQ;EAClB,OAAO,EAAE,SAAS;EAClB,UAAU,EAAE,OAAO;EACnB,MAAM,EAAE,iBAAiB;EACzB,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,MAAM,EAAE,KAAK;EACb,WAAW,EAAE,gBAAgB;;;AAK7B,oCAAM;EACJ,OAAO,EAAE,MAAM;EACf,WAAW,EAAE,CAAC;AAEhB,wBAAS;EACP,OAAO,EAAE,KAAK;EACd,OAAO,EAAE,GAAG;EACZ,MAAM,EAAE,KAAI;AAEd,yBAAU;EACR,OAAO,EAAE,GAAO;EAChB,SAAS,EAAE,MAAM;EACjB,YAAY,EAAE,GAAG;EACjB,QAAQ,EAAE,QAAQ;EAClB,WAAW,EAAE,OAAM;EACnB,WAAW,EAAE,KAAK;;;AAMtB,gBAAgB;EACd,UAAU,EA7bI,GAAG;;AA+bnB,6BAA6B;EAC3B,UAAU,EAAE,GAAG", -"sources": ["highlight.scss","fontello.scss","all.sass","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/typography/text/_replacement.scss","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/css3/_flexbox.scss","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/_support.scss","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/utilities/general/_clearfix.scss","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/utilities/general/_hacks.scss"], +"mappings": ";AAAA,QAAS;EACP,OAAO,EAAE,KAAK;EAAE,OAAO,EAAE,KAAK;EAC9B,KAAK,EAAE,IAAI;;AAGb,uHAAU;EACR,KAAK,EAAE,OAAO;;AAGhB,+CAAY;EACV,KAAK,EAAE,IAAI;;AAIX,sBAAS;EACP,KAAK,EAAE,IAAI;EACX,UAAU,EAAE,MAAM;;AAiBpB,qCAAkB;EAChB,WAAW,EAAE,IAAI;AAenB,sBAAa;EACX,KAAK,EAAE,IAAI;;AClDf,UASC;EARC,WAAW,EAAE,UAAU;EACvB,GAAG,EAAE,qCAAqC;EAC1C,GAAG,EAAE,sPAG4D;EACjE,WAAW,EAAE,MAAM;EACnB,UAAU,EAAE,MAAM;AAEpB,iGAAiG;AACjG,4FAA4F;AAC5F;;;;;;;EAOE;AAED,iDAAkD;EACjD,WAAW,EAAE,UAAU;EACvB,UAAU,EAAE,MAAM;EAClB,WAAW,EAAE,MAAM;EACnB,KAAK,EAAE,IAAI;EAEX,OAAO,EAAE,YAAY;EACrB,eAAe,EAAE,OAAO;EACxB,KAAK,EAAE,GAAG;EACV,UAAU,EAAE,MAAM;EAElB,iEAAiE;EACjE,YAAY,EAAE,MAAM;EACpB,cAAc,EAAE,IAAI;EAEpB,+CAA+C;EAC/C,WAAW,EAAE,GAAG;;AAGlB,mBAAoB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AACnD,iBAAkB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AACjD,mBAAoB;EAAE,OAAO,EAAE,OAAO;EAAE,SAAS,EAAE,IAAI;EAAE,QAAQ,EAAE,QAAQ;EAAE,GAAG,EAAE,KAAK;EAAE,IAAI,EAAE,KAAK;;AAAI,SAAS;AACjH,kBAAmB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AAClD,oBAAqB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;;;ACnBpD,uDAAU;EACR,OAAO,EAAE,KAAK;EACd,SAAS,EApBE,KAAK;EAqBhB,MAAM,EAAE,MAAM;EACd,OAAO,EAAE,MAAe;;AAE1B,0CAAoB;EAClB,UAAU,EAAE,OAAO;EAEnB,sDAAO;IACL,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,YAAY;IACrB,KAAK,EAAE,IAAI;;AAEf,gCAAW;EACT,cAAc,EAAE,SAAS;EACzB,cAAc,EAAE,KAAI;;AAItB,6CAAU;ECMN,WAAW,EAAE,SAA8C;EAC3D,QAAQ,EAAE,MAAM;EAChB,UAAU,EAAE,IAAI;EAShB,cAAc,EAAC,UAAU;;ADd7B,gCAAa;EEkCH,OAAO,EAAE,YAAyB;EAAlC,OAAO,EAAE,IAAyB;;AF9B5C,IAAI;EACF,WAAW,EAlCA,6DAA6D;EAmCxE,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;EAChB,sBAAsB,EAAE,WAAW;;;AAIrC,WAAW;EACT,eAAe,EAAE,IAAI;EACrB,KAAK,EA9CY,OAAkB;;AAgDrC,kBAAkB;EAChB,WAAW,EAAE,GAAG;EAChB,QAAQ,EAAE,QAAQ;EAClB,IAAI,EAAE,IAAI;EACV,YAAY,EAAE,GAAG;EAEjB,8EAAa;IACX,UAAU,EAAE,CAAC;EAEf,0NAAsC;IACpC,SAAS,EAAE,OAAO;IAClB,gSAAQ;MACN,WAAW,EAAE,MAAK;MAClB,KAAK,EAAE,KAAI;MACX,QAAQ,EAAE,QAAQ;MAClB,OAAO,EAAE,GAAG;;AAElB,EAAE;EACA,WAAW,EAAE,GAAG;EAChB,KAAK,EAtEQ,OAAe;;AAwE9B,EAAE;EACA,MAAM,EAAE,YAAuB;EAC/B,KAAK,EAzEM,OAAe;EA0E1B,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;;AAElB,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,SAAS,EAAE,IAAI;;AAEjB,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,SAAS,EAAE,IAAI;;AAEjB,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,WAAW,EAAE,GAAG;EAChB,SAAS,EAAE,OAAO;EAElB,OAAI;IACF,WAAW,EAAE,GAAG;;AAEpB,QAAQ;EACN,WAAW,EAAE,MAAM;EACnB,MAAM,EAAE,UAAU;;AAEpB,EAAE;EACA,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,GAAG;;AAEpB,CAAC;EACC,KAAK,EAtGM,OAAe;;AAwG5B,iBAAiB;EACf,MAAM,EAAE,MAAM;EACd,OAAO,EAAE,mBAAmB;EAC5B,aAAa,EArGM,GAAG;EAsGtB,KAAK,EAAE,IAAyB;EAChC,UAAU,EAAE,sBAAuB;EACnC,MAAM,EAAE,iBAA2B;EAEnC,2BAAI;IACF,UAAU,EAAE,kBAAkB;EAEhC,qBAAC;IACC,aAAa,EAAE,GAAG;EAEpB,2CAAY;IACV,aAAa,EAAE,CAAC;;AAEpB,mBAAmB;EACjB,OAAO,EAAE,OAAO;EAChB,UAAU,EAAE,mBAAmB;EAC/B,WAAW,EAAE,MAAM;;AAErB,IAAI;EACF,WAAW,EAAE,OAAO;;AAEtB,OAAO;EACL,UAAU,EAAE,MAAM;;;AAIpB,SAAS;EACP,WAAW,EAAE,GAAG;EAChB,UAAU,EAzIG,OAAe;EA0I5B,aAAa,EAAE,iBAA2B;EAK1C,YAAE;IGgMF,uBAAwC,EH9LrB,aAAa;IG8LhC,eAAwC,EH9LrB,aAAa;IAC9B,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,WAAW;IAEpB,oCAAiD;MAPnD,YAAE;QGgMF,sBAAwC,EHxLpB,MAAM;QGwL1B,cAAwC,EHxLpB,MAAM;QACtB,UAAU,EAAE,MAAM;EAEtB,YAAE;IGqLF,YAAwC,EHpLhC,QAAQ;IGoLhB,IAAwC,EHpLhC,QAAQ;EAEhB,WAAC;IACC,eAAe,EAAE,IAAI;IACrB,WAAW,EAAE,GAAG;IAChB,KAAK,EAAE,KAAK;IACZ,cAAc,EAAE,KAAI;EAGpB,mBAAC;IACC,WAAW,EAAE,GAAG;IAChB,cAAc,EAAE,KAAI;EAExB,wBAAc;IACZ,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,OAAO;IAChB,gBAAgB,EAAE,OAAyB;IAC3C,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,KAAK,EAAE,KAAK;IACZ,aAAa,EAxKI,GAAG;IAyKpB,QAAQ,EAAE,QAAQ;IAClB,GAAG,EAAE,IAAI;IAET,gCAAO;MAEL,cAAc,EAAE,kBAAkB;;;AAMtC,eAAQ;EACN,OAAO,EAAE,cAAuB;EAChC,UAAU,EAzLG,OAAkB;EA0L/B,aAAa,EAAE,iBAA2B;AAE5C,kBAAW;EAET,UAAU,EAAE,MAAM;EAClB,MAAM,EAAE,KAAK;EACb,MAAM,EAAE,CAAC;EACT,OAAO,EAAE,CAAC;EACV,IAAI,EAAE,IAAI;EACV,UAAU,EAAE,6CAA6C;EACzD,eAAe,EAAE,OAAO;AAE1B,SAAE;EACA,UAAU,EAAE,MAAM;EAClB,MAAM,EAAE,aAAa;EACrB,OAAO,EAAE,CAAC;EACV,IAAI,EAAE,CAAC;EACP,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,cAAc,EAAE,SAAS;AAE3B,kBAAW;EG4HX,mBAAwC,EHzHzB,MAAM;EGyHrB,WAAwC,EHzHzB,MAAM;EGyHrB,uBAAwC,EHxHrB,MAAM;EGwHzB,eAAwC,EHxHrB,MAAM;AAEzB,oBAAa;EACX,OAAO,EAAE,KAAK;EACd,MAAM,EAAE,QAAQ;EAChB,OAAO,EAAE,QAAQ;EACjB,aAAa,EAtNI,GAAG;EAuNpB,MAAM,EAAE,iBAAyB;EACjC,UAAU,EAAE,KAAK;EACjB,eAAe,EAAE,IAAI;EACrB,UAAU,EAAE,MAAM;AAEpB,oBAAa;EACX,MAAM,EAAE,WAAW;EACnB,SAAS,EAAE,IAAI;EACf,UAAU,EAAE,MAAM;EAClB,QAAQ,EAAE,QAAQ;EAClB,GAAG,EAAE,IAAI;EACT,KAAK,EAxOI,OAAe;EA0OxB,sBAAC;IACC,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,CAAC;AAEb,oCAAiD;EAC/C,eAAQ;IACN,WAAW,EAAE,IAAI;IACjB,cAAc,EAAE,IAAI;EAEtB,SAAE;IACA,MAAM,EAAE,gBAAgB;IACxB,SAAS,EAAE,IAAI;EAEjB,kBAAW;IGuFb,sBAAwC,EHtFpB,MAAM;IGsF1B,cAAwC,EHtFpB,MAAM;;;AAK5B,MAAM;EACJ,OAAO,EAAE,MAAuB;EAChC,UAAU,EAAE,MAAM;EAClB,SAAS,EAAE,IAAI;EACf,KAAK,EAjQM,OAAe;EAmQ1B,oBAAa;IACX,UAAU,EAAE,CAAC;IACb,aAAa,EAAE,CAAC;IAChB,WAAW,EAAE,CAAC;IAEd,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,iBAAyB;EAEvC,WAAI;IACF,OAAO,EAAE,YAAY;IACrB,cAAc,EAAE,MAAM;EAGtB,iBAAC;IACC,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,MAAK;EAElB,oBAAa;IAEX,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,QAAQ;IAClB,IAAI,EAAE,MAAK;IAEX,yBAAI;MAEF,KAAK,EAAE,CAAC;IAGV,sBAAC;MACC,KAAK,EAAE,GAAG;MACV,OAAO,EAAE,MAAK;MACd,OAAO,EAAE,YAAY;;;AAI3B,aAAa;EIxSX,QAAQ,EAAE,MAAM;ECiBd,KAAK,EAAE,CAAC;EL0RV,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,IAAI;;AAErB,QAAQ;EACN,KAAK,EAnTS,KAAK;EAoTnB,UAAU,EAAE,GAAG;EACf,KAAK,EAAE,IAAI;EAIX,WAAE;IACA,SAAS,EAAE,IAAI;IACf,gBAAgB,EAAE,KAAK;IACvB,OAAO,EAAE,CAAC;IACV,KAAK,EA7TO,KAAK;IA8TjB,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,GAAG;EAElB,iBAAQ;IACN,KAAK,EAlUO,KAAK;IAmUjB,UAAU,EAAE,IAAI;EAElB,gCAAuB;IACrB,KAAK,EAAE,KAAK;IACZ,aAAa,EAAE,IAAI;IACnB,OAAO,EAAE,IAAI;IACb,cAAc,EAAE,GAAG;IAEnB,sCAAK;MACH,OAAO,EAAE,IAAI;MACb,YAAY,EAAE,KAAI;IAEpB,gDAAe;MACb,cAAc,EAAE,GAAG;MACnB,SAAS,EAAE,CAAC;EAIhB,oCAAwE;IAnC1E,QAAQ;MA0CJ,KAAK,EAAE,IAAI;MACX,KAAK,EAAE,IAAI;MANX,4CAAmC;QACjC,OAAO,EAAE,IAAI;MAMf,YAAG;QACD,aAAa,EAAE,CAAC;MAIlB,gCAAuB;QACrB,KAAK,EAAE,IAAI;QACX,sCAAK;UACH,OAAO,EAAE,MAAM;;AAMvB,oCAAwE;EACtE,mBAAmB;IACjB,WAAW,EAAE,KAAqB;IAClC,YAAY,EAAE,mBAA0D;AAE5E,oCAAuE;EACrE,mBAAmB;IACjB,YAAY,EAAE,IAAI;;AAItB,iBAAiB;EACf,aAAa,EAAE,IAAI;EACnB,SAAS,EAAE,IAAI;EAEf,oBAAE;IACA,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;IAEV,0BAAK;MACH,OAAO,EAAE,UAAU;EAEvB,mBAAC;IACC,eAAe,EAAE,IAAI;IACrB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,KAAK;IAEd,yBAAO;MACL,KAAK,EAnYE,OAAe;;AAqY5B,2BAA2B;EACzB,OAAO,EAAE,SAAS;;;AAKpB,aAAa;EACX,aAAa,EAtYM,GAAG;EAuYtB,QAAQ,EAAE,QAAQ;EAClB,OAAO,EAAE,SAAS;EAClB,UAAU,EAAE,OAAO;EACnB,MAAM,EAAE,iBAAiB;EACzB,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,MAAM,EAAE,KAAK;EACb,WAAW,EAAE,gBAAgB;;;AAK7B,oCAAM;EACJ,OAAO,EAAE,MAAM;EACf,WAAW,EAAE,CAAC;AAEhB,wBAAS;EACP,OAAO,EAAE,KAAK;EACd,OAAO,EAAE,GAAG;EACZ,MAAM,EAAE,KAAI;AAEd,yBAAU;EACR,OAAO,EAAE,GAAO;EAChB,SAAS,EAAE,MAAM;EACjB,YAAY,EAAE,GAAG;EACjB,QAAQ,EAAE,QAAQ;EAClB,WAAW,EAAE,OAAM;EACnB,WAAW,EAAE,KAAK;;;AAMtB,gBAAgB;EACd,UAAU,EAxaI,GAAG;;AA0anB,6BAA6B;EAC3B,UAAU,EAAE,GAAG", +"sources": ["highlight.scss","fontello.scss","all.sass","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/typography/text/_replacement.scss","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/css3/_flexbox.scss","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/_support.scss","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/utilities/general/_clearfix.scss","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/utilities/general/_hacks.scss"], "names": [], "file": "all.css" } \ No newline at end of file diff --git a/stylesheets/all.sass b/stylesheets/all.sass index 55874d293..e142db93b 100644 --- a/stylesheets/all.sass +++ b/stylesheets/all.sass @@ -55,7 +55,6 @@ body font-size: 15px line-height: 1.6 -webkit-font-smoothing: antialiased - counter-reset: h2counter /** Typography */ @@ -75,54 +74,34 @@ h1, h2, h3, h4, h5 &:hover .headerlink, .headerlink:hover font-size: inherit &::after + margin-left: -.8em + width: .8em position: absolute - left: 0 - width: 1em content: "¶" h1 font-weight: 500 color: $color-accent - counter-reset: h2counter h2 margin: $h2-margin-top 0 15px 0 color: $color-main font-size: 22px line-height: 1.3 - counter-reset: h3counter - - &::before - content: counter(h2counter) "\0000a0\0000a0" - counter-increment: h2counter h3 margin: 30px 0 15px 0 font-size: 18px - counter-reset: h4counter - - &::before - content: counter(h2counter) "." counter(h3counter) "\0000a0\0000a0" - counter-increment: h3counter h4 margin: 20px 0 10px 0 font-size: 16px - counter-reset: h5counter - - &::before - content: counter(h2counter) "." counter(h3counter) "." counter(h4counter) "\0000a0\0000a0" - counter-increment: h4counter h5 margin: 20px 0 10px 0 font-weight: 500 font-size: inherit - &::before - content: counter(h2counter) "." counter(h3counter) "." counter(h4counter) "." counter(h5counter) "\0000a0\0000a0" - counter-increment: h5counter - code font-weight: 600 From 2aef19179e51762b69411ef0120e05f795342af6 Mon Sep 17 00:00:00 2001 From: Timothy Stone Date: Tue, 31 Aug 2021 09:08:26 -0400 Subject: [PATCH 07/93] Add Specification Numbering (#1580) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Address oversight of specification numbering scope issue in #1574. From the original PR: Citing the specification can be cumbersome. Following RFC numbering formats, the specification is numbered following ISO 2145 at each HEADER element, e.g., `h1`, `h2`, &tc. The numbers are CSS "generated" content and provide support for the additive focus of the specification. The paragraph glyph is repositioned absolutely, relative to the header. The `_config.yml` is updated to support building. bundle otherwise failed on Ruby 2.7.x. Updated the exclusions file for IntelliJ. Regarding the `_config.yml` change, I followed the README instructions and found that the site would not build with Ruby 2.3 installed on the Mac. I upgraded to Ruby 2.7 via homebrew—required as the Jekyll markdown gem would not compile—and encountered the same problem. Some research, i.e., SO-fu, found numerous posts regarding the vendor gem path with regards to Jekyll test files. Adding this line corrected the problem. The move to Ruby 2.7 appears to have generated updates to the map file. --- .gitignore | 7 +++++++ _config.yml | 1 + _layouts/page.html | 41 +++++++++++++++++++++-------------------- stylesheets/all.css | 30 ++++++++++++++++++++++++------ stylesheets/all.css.map | 4 ++-- stylesheets/all.sass | 35 +++++++++++++++++++++++++++++++++-- 6 files changed, 88 insertions(+), 30 deletions(-) diff --git a/.gitignore b/.gitignore index d30e720ea..e369c5255 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,13 @@ Gemfile.lock # Ignore the build directory /public +# Ignore IntelliJ's config +*.iml +/.idea + +# Ignore Ruby vendor +/vendor + # Ignore Sass' cache /.sass-cache diff --git a/_config.yml b/_config.yml index d3c05f7a1..733972291 100644 --- a/_config.yml +++ b/_config.yml @@ -44,6 +44,7 @@ exclude: - .gitignore - ./public - ./stylesheets/*.scss + - vendor port: 9876 diff --git a/_layouts/page.html b/_layouts/page.html index 31dddb6d9..6555a979c 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -4,34 +4,35 @@ {% include global_head_assets.html %} {% comment %} - Below, we're either dealing with a generic page or a page from the - specification collection. For generic pages, we get a title just by - reading page.title but, for specification pages, we build their title - dynamically to take into account the page's version number and its - relationship to the latest version. + Below, we're either dealing with a generic page or a page from the + specification collection. For generic pages, we get a title just by + reading page.title but, for specification pages, we build their title + dynamically to take into account the page's version number and its + relationship to the latest version. {% endcomment %} {% if page.is_spec_page %} - {% capture page_title %} - {% include title_for_version.md is_latest_version=page.is_latest_version version=page.version %} - {% endcapture %} + {% assign class_spec='class="spec_page"' %} + {% capture page_title %} + {% include title_for_version.md is_latest_version=page.is_latest_version version=page.version %} + {% endcapture %} {% else %} - {% assign page_title = page.title %} + {% assign page_title = page.title %} {% endif %} Codestin Search App - - {% include site_navigation.html %} - {% if page.show_masthead %} -
-
-

JSON:API

-

A specification for building APIs in JSON

-
- {% for link in site.quicklinks %} - {{link.title}} - {% endfor %} + + {% include site_navigation.html %} + {% if page.show_masthead %} +
+
+

JSON:API

+

A specification for building APIs in JSON

+
+ {% for link in site.quicklinks %} + {{link.title}} + {% endfor %}
{% if site.announcement %}
diff --git a/stylesheets/all.css b/stylesheets/all.css index cf272d6c9..53616dad5 100644 --- a/stylesheets/all.css +++ b/stylesheets/all.css @@ -108,6 +108,8 @@ body { font-size: 15px; line-height: 1.6; -webkit-font-smoothing: antialiased; } + body.spec_page { + counter-reset: h2counter; } /** Typography */ .headerlink { @@ -124,33 +126,53 @@ h1, h2, h3, h4, h5 { h1:hover .headerlink, h1 .headerlink:hover, h2:hover .headerlink, h2 .headerlink:hover, h3:hover .headerlink, h3 .headerlink:hover, h4:hover .headerlink, h4 .headerlink:hover, h5:hover .headerlink, h5 .headerlink:hover { font-size: inherit; } h1:hover .headerlink::after, h1 .headerlink:hover::after, h2:hover .headerlink::after, h2 .headerlink:hover::after, h3:hover .headerlink::after, h3 .headerlink:hover::after, h4:hover .headerlink::after, h4 .headerlink:hover::after, h5:hover .headerlink::after, h5 .headerlink:hover::after { - margin-left: -0.8em; - width: 0.8em; position: absolute; + left: 0; + width: 1em; content: "¶"; } h1 { font-weight: 500; color: #0b4e22; } + .spec_page h1 { + counter-reset: h2counter; } h2 { margin: 2em 0 15px 0; color: #5a5a5a; font-size: 22px; line-height: 1.3; } + .spec_page h2 { + counter-reset: h3counter; } + .spec_page h2::before { + content: counter(h2counter) "  "; + counter-increment: h2counter; } h3 { margin: 30px 0 15px 0; font-size: 18px; } + .spec_page h3 { + counter-reset: h4counter; } + .spec_page h3::before { + content: counter(h2counter) "." counter(h3counter) "  "; + counter-increment: h3counter; } h4 { margin: 20px 0 10px 0; font-size: 16px; } + .spec_page h4 { + counter-reset: h5counter; } + .spec_page h4::before { + content: counter(h2counter) "." counter(h3counter) "." counter(h4counter) "  "; + counter-increment: h4counter; } h5 { margin: 20px 0 10px 0; font-weight: 500; font-size: inherit; } + .spec_page h5::before { + content: counter(h2counter) "." counter(h3counter) "." counter(h4counter) "." counter(h5counter) "  "; + counter-increment: h5counter; } h5 code { font-weight: 600; } @@ -422,8 +444,4 @@ pre.highlight { .profile-page h1 + section h2 { margin-top: 1em; } -.profile-page .editor + .editor { - margin-top: 1em; -} - /*# sourceMappingURL=all.css.map */ diff --git a/stylesheets/all.css.map b/stylesheets/all.css.map index d7e0d24e7..a0f8858ac 100644 --- a/stylesheets/all.css.map +++ b/stylesheets/all.css.map @@ -1,7 +1,7 @@ { "version": 3, -"mappings": ";AAAA,QAAS;EACP,OAAO,EAAE,KAAK;EAAE,OAAO,EAAE,KAAK;EAC9B,KAAK,EAAE,IAAI;;AAGb,uHAAU;EACR,KAAK,EAAE,OAAO;;AAGhB,+CAAY;EACV,KAAK,EAAE,IAAI;;AAIX,sBAAS;EACP,KAAK,EAAE,IAAI;EACX,UAAU,EAAE,MAAM;;AAiBpB,qCAAkB;EAChB,WAAW,EAAE,IAAI;AAenB,sBAAa;EACX,KAAK,EAAE,IAAI;;AClDf,UASC;EARC,WAAW,EAAE,UAAU;EACvB,GAAG,EAAE,qCAAqC;EAC1C,GAAG,EAAE,sPAG4D;EACjE,WAAW,EAAE,MAAM;EACnB,UAAU,EAAE,MAAM;AAEpB,iGAAiG;AACjG,4FAA4F;AAC5F;;;;;;;EAOE;AAED,iDAAkD;EACjD,WAAW,EAAE,UAAU;EACvB,UAAU,EAAE,MAAM;EAClB,WAAW,EAAE,MAAM;EACnB,KAAK,EAAE,IAAI;EAEX,OAAO,EAAE,YAAY;EACrB,eAAe,EAAE,OAAO;EACxB,KAAK,EAAE,GAAG;EACV,UAAU,EAAE,MAAM;EAElB,iEAAiE;EACjE,YAAY,EAAE,MAAM;EACpB,cAAc,EAAE,IAAI;EAEpB,+CAA+C;EAC/C,WAAW,EAAE,GAAG;;AAGlB,mBAAoB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AACnD,iBAAkB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AACjD,mBAAoB;EAAE,OAAO,EAAE,OAAO;EAAE,SAAS,EAAE,IAAI;EAAE,QAAQ,EAAE,QAAQ;EAAE,GAAG,EAAE,KAAK;EAAE,IAAI,EAAE,KAAK;;AAAI,SAAS;AACjH,kBAAmB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AAClD,oBAAqB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;;;ACnBpD,uDAAU;EACR,OAAO,EAAE,KAAK;EACd,SAAS,EApBE,KAAK;EAqBhB,MAAM,EAAE,MAAM;EACd,OAAO,EAAE,MAAe;;AAE1B,0CAAoB;EAClB,UAAU,EAAE,OAAO;EAEnB,sDAAO;IACL,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,YAAY;IACrB,KAAK,EAAE,IAAI;;AAEf,gCAAW;EACT,cAAc,EAAE,SAAS;EACzB,cAAc,EAAE,KAAI;;AAItB,6CAAU;ECMN,WAAW,EAAE,SAA8C;EAC3D,QAAQ,EAAE,MAAM;EAChB,UAAU,EAAE,IAAI;EAShB,cAAc,EAAC,UAAU;;ADd7B,gCAAa;EEkCH,OAAO,EAAE,YAAyB;EAAlC,OAAO,EAAE,IAAyB;;AF9B5C,IAAI;EACF,WAAW,EAlCA,6DAA6D;EAmCxE,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;EAChB,sBAAsB,EAAE,WAAW;;;AAIrC,WAAW;EACT,eAAe,EAAE,IAAI;EACrB,KAAK,EA9CY,OAAkB;;AAgDrC,kBAAkB;EAChB,WAAW,EAAE,GAAG;EAChB,QAAQ,EAAE,QAAQ;EAClB,IAAI,EAAE,IAAI;EACV,YAAY,EAAE,GAAG;EAEjB,8EAAa;IACX,UAAU,EAAE,CAAC;EAEf,0NAAsC;IACpC,SAAS,EAAE,OAAO;IAClB,gSAAQ;MACN,WAAW,EAAE,MAAK;MAClB,KAAK,EAAE,KAAI;MACX,QAAQ,EAAE,QAAQ;MAClB,OAAO,EAAE,GAAG;;AAElB,EAAE;EACA,WAAW,EAAE,GAAG;EAChB,KAAK,EAtEQ,OAAe;;AAwE9B,EAAE;EACA,MAAM,EAAE,YAAuB;EAC/B,KAAK,EAzEM,OAAe;EA0E1B,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;;AAElB,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,SAAS,EAAE,IAAI;;AAEjB,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,SAAS,EAAE,IAAI;;AAEjB,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,WAAW,EAAE,GAAG;EAChB,SAAS,EAAE,OAAO;EAElB,OAAI;IACF,WAAW,EAAE,GAAG;;AAEpB,QAAQ;EACN,WAAW,EAAE,MAAM;EACnB,MAAM,EAAE,UAAU;;AAEpB,EAAE;EACA,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,GAAG;;AAEpB,CAAC;EACC,KAAK,EAtGM,OAAe;;AAwG5B,iBAAiB;EACf,MAAM,EAAE,MAAM;EACd,OAAO,EAAE,mBAAmB;EAC5B,aAAa,EArGM,GAAG;EAsGtB,KAAK,EAAE,IAAyB;EAChC,UAAU,EAAE,sBAAuB;EACnC,MAAM,EAAE,iBAA2B;EAEnC,2BAAI;IACF,UAAU,EAAE,kBAAkB;EAEhC,qBAAC;IACC,aAAa,EAAE,GAAG;EAEpB,2CAAY;IACV,aAAa,EAAE,CAAC;;AAEpB,mBAAmB;EACjB,OAAO,EAAE,OAAO;EAChB,UAAU,EAAE,mBAAmB;EAC/B,WAAW,EAAE,MAAM;;AAErB,IAAI;EACF,WAAW,EAAE,OAAO;;AAEtB,OAAO;EACL,UAAU,EAAE,MAAM;;;AAIpB,SAAS;EACP,WAAW,EAAE,GAAG;EAChB,UAAU,EAzIG,OAAe;EA0I5B,aAAa,EAAE,iBAA2B;EAK1C,YAAE;IGgMF,uBAAwC,EH9LrB,aAAa;IG8LhC,eAAwC,EH9LrB,aAAa;IAC9B,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,WAAW;IAEpB,oCAAiD;MAPnD,YAAE;QGgMF,sBAAwC,EHxLpB,MAAM;QGwL1B,cAAwC,EHxLpB,MAAM;QACtB,UAAU,EAAE,MAAM;EAEtB,YAAE;IGqLF,YAAwC,EHpLhC,QAAQ;IGoLhB,IAAwC,EHpLhC,QAAQ;EAEhB,WAAC;IACC,eAAe,EAAE,IAAI;IACrB,WAAW,EAAE,GAAG;IAChB,KAAK,EAAE,KAAK;IACZ,cAAc,EAAE,KAAI;EAGpB,mBAAC;IACC,WAAW,EAAE,GAAG;IAChB,cAAc,EAAE,KAAI;EAExB,wBAAc;IACZ,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,OAAO;IAChB,gBAAgB,EAAE,OAAyB;IAC3C,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,KAAK,EAAE,KAAK;IACZ,aAAa,EAxKI,GAAG;IAyKpB,QAAQ,EAAE,QAAQ;IAClB,GAAG,EAAE,IAAI;IAET,gCAAO;MAEL,cAAc,EAAE,kBAAkB;;;AAMtC,eAAQ;EACN,OAAO,EAAE,cAAuB;EAChC,UAAU,EAzLG,OAAkB;EA0L/B,aAAa,EAAE,iBAA2B;AAE5C,kBAAW;EAET,UAAU,EAAE,MAAM;EAClB,MAAM,EAAE,KAAK;EACb,MAAM,EAAE,CAAC;EACT,OAAO,EAAE,CAAC;EACV,IAAI,EAAE,IAAI;EACV,UAAU,EAAE,6CAA6C;EACzD,eAAe,EAAE,OAAO;AAE1B,SAAE;EACA,UAAU,EAAE,MAAM;EAClB,MAAM,EAAE,aAAa;EACrB,OAAO,EAAE,CAAC;EACV,IAAI,EAAE,CAAC;EACP,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,cAAc,EAAE,SAAS;AAE3B,kBAAW;EG4HX,mBAAwC,EHzHzB,MAAM;EGyHrB,WAAwC,EHzHzB,MAAM;EGyHrB,uBAAwC,EHxHrB,MAAM;EGwHzB,eAAwC,EHxHrB,MAAM;AAEzB,oBAAa;EACX,OAAO,EAAE,KAAK;EACd,MAAM,EAAE,QAAQ;EAChB,OAAO,EAAE,QAAQ;EACjB,aAAa,EAtNI,GAAG;EAuNpB,MAAM,EAAE,iBAAyB;EACjC,UAAU,EAAE,KAAK;EACjB,eAAe,EAAE,IAAI;EACrB,UAAU,EAAE,MAAM;AAEpB,oBAAa;EACX,MAAM,EAAE,WAAW;EACnB,SAAS,EAAE,IAAI;EACf,UAAU,EAAE,MAAM;EAClB,QAAQ,EAAE,QAAQ;EAClB,GAAG,EAAE,IAAI;EACT,KAAK,EAxOI,OAAe;EA0OxB,sBAAC;IACC,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,CAAC;AAEb,oCAAiD;EAC/C,eAAQ;IACN,WAAW,EAAE,IAAI;IACjB,cAAc,EAAE,IAAI;EAEtB,SAAE;IACA,MAAM,EAAE,gBAAgB;IACxB,SAAS,EAAE,IAAI;EAEjB,kBAAW;IGuFb,sBAAwC,EHtFpB,MAAM;IGsF1B,cAAwC,EHtFpB,MAAM;;;AAK5B,MAAM;EACJ,OAAO,EAAE,MAAuB;EAChC,UAAU,EAAE,MAAM;EAClB,SAAS,EAAE,IAAI;EACf,KAAK,EAjQM,OAAe;EAmQ1B,oBAAa;IACX,UAAU,EAAE,CAAC;IACb,aAAa,EAAE,CAAC;IAChB,WAAW,EAAE,CAAC;IAEd,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,iBAAyB;EAEvC,WAAI;IACF,OAAO,EAAE,YAAY;IACrB,cAAc,EAAE,MAAM;EAGtB,iBAAC;IACC,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,MAAK;EAElB,oBAAa;IAEX,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,QAAQ;IAClB,IAAI,EAAE,MAAK;IAEX,yBAAI;MAEF,KAAK,EAAE,CAAC;IAGV,sBAAC;MACC,KAAK,EAAE,GAAG;MACV,OAAO,EAAE,MAAK;MACd,OAAO,EAAE,YAAY;;;AAI3B,aAAa;EIxSX,QAAQ,EAAE,MAAM;ECiBd,KAAK,EAAE,CAAC;EL0RV,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,IAAI;;AAErB,QAAQ;EACN,KAAK,EAnTS,KAAK;EAoTnB,UAAU,EAAE,GAAG;EACf,KAAK,EAAE,IAAI;EAIX,WAAE;IACA,SAAS,EAAE,IAAI;IACf,gBAAgB,EAAE,KAAK;IACvB,OAAO,EAAE,CAAC;IACV,KAAK,EA7TO,KAAK;IA8TjB,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,GAAG;EAElB,iBAAQ;IACN,KAAK,EAlUO,KAAK;IAmUjB,UAAU,EAAE,IAAI;EAElB,gCAAuB;IACrB,KAAK,EAAE,KAAK;IACZ,aAAa,EAAE,IAAI;IACnB,OAAO,EAAE,IAAI;IACb,cAAc,EAAE,GAAG;IAEnB,sCAAK;MACH,OAAO,EAAE,IAAI;MACb,YAAY,EAAE,KAAI;IAEpB,gDAAe;MACb,cAAc,EAAE,GAAG;MACnB,SAAS,EAAE,CAAC;EAIhB,oCAAwE;IAnC1E,QAAQ;MA0CJ,KAAK,EAAE,IAAI;MACX,KAAK,EAAE,IAAI;MANX,4CAAmC;QACjC,OAAO,EAAE,IAAI;MAMf,YAAG;QACD,aAAa,EAAE,CAAC;MAIlB,gCAAuB;QACrB,KAAK,EAAE,IAAI;QACX,sCAAK;UACH,OAAO,EAAE,MAAM;;AAMvB,oCAAwE;EACtE,mBAAmB;IACjB,WAAW,EAAE,KAAqB;IAClC,YAAY,EAAE,mBAA0D;AAE5E,oCAAuE;EACrE,mBAAmB;IACjB,YAAY,EAAE,IAAI;;AAItB,iBAAiB;EACf,aAAa,EAAE,IAAI;EACnB,SAAS,EAAE,IAAI;EAEf,oBAAE;IACA,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;IAEV,0BAAK;MACH,OAAO,EAAE,UAAU;EAEvB,mBAAC;IACC,eAAe,EAAE,IAAI;IACrB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,KAAK;IAEd,yBAAO;MACL,KAAK,EAnYE,OAAe;;AAqY5B,2BAA2B;EACzB,OAAO,EAAE,SAAS;;;AAKpB,aAAa;EACX,aAAa,EAtYM,GAAG;EAuYtB,QAAQ,EAAE,QAAQ;EAClB,OAAO,EAAE,SAAS;EAClB,UAAU,EAAE,OAAO;EACnB,MAAM,EAAE,iBAAiB;EACzB,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,MAAM,EAAE,KAAK;EACb,WAAW,EAAE,gBAAgB;;;AAK7B,oCAAM;EACJ,OAAO,EAAE,MAAM;EACf,WAAW,EAAE,CAAC;AAEhB,wBAAS;EACP,OAAO,EAAE,KAAK;EACd,OAAO,EAAE,GAAG;EACZ,MAAM,EAAE,KAAI;AAEd,yBAAU;EACR,OAAO,EAAE,GAAO;EAChB,SAAS,EAAE,MAAM;EACjB,YAAY,EAAE,GAAG;EACjB,QAAQ,EAAE,QAAQ;EAClB,WAAW,EAAE,OAAM;EACnB,WAAW,EAAE,KAAK;;;AAMtB,gBAAgB;EACd,UAAU,EAxaI,GAAG;;AA0anB,6BAA6B;EAC3B,UAAU,EAAE,GAAG", -"sources": ["highlight.scss","fontello.scss","all.sass","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/typography/text/_replacement.scss","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/css3/_flexbox.scss","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/_support.scss","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/utilities/general/_clearfix.scss","../../../../../../../usr/local/lib/ruby/gems/2.4.0/gems/compass-core-1.0.3/stylesheets/compass/utilities/general/_hacks.scss"], +"mappings": ";AAAA,QAAS;EACP,OAAO,EAAE,KAAK;EAAE,OAAO,EAAE,KAAK;EAC9B,KAAK,EAAE,IAAI;;AAGb,uHAAU;EACR,KAAK,EAAE,OAAO;;AAGhB,+CAAY;EACV,KAAK,EAAE,IAAI;;AAIX,sBAAS;EACP,KAAK,EAAE,IAAI;EACX,UAAU,EAAE,MAAM;;AAiBpB,qCAAkB;EAChB,WAAW,EAAE,IAAI;AAenB,sBAAa;EACX,KAAK,EAAE,IAAI;;AClDf,UASC;EARC,WAAW,EAAE,UAAU;EACvB,GAAG,EAAE,qCAAqC;EAC1C,GAAG,EAAE,sPAG4D;EACjE,WAAW,EAAE,MAAM;EACnB,UAAU,EAAE,MAAM;AAEpB,iGAAiG;AACjG,4FAA4F;AAC5F;;;;;;;EAOE;AAED,iDAAkD;EACjD,WAAW,EAAE,UAAU;EACvB,UAAU,EAAE,MAAM;EAClB,WAAW,EAAE,MAAM;EACnB,KAAK,EAAE,IAAI;EAEX,OAAO,EAAE,YAAY;EACrB,eAAe,EAAE,OAAO;EACxB,KAAK,EAAE,GAAG;EACV,UAAU,EAAE,MAAM;EAElB,iEAAiE;EACjE,YAAY,EAAE,MAAM;EACpB,cAAc,EAAE,IAAI;EAEpB,+CAA+C;EAC/C,WAAW,EAAE,GAAG;;AAGlB,mBAAoB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AACnD,iBAAkB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AACjD,mBAAoB;EAAE,OAAO,EAAE,OAAO;EAAE,SAAS,EAAE,IAAI;EAAE,QAAQ,EAAE,QAAQ;EAAE,GAAG,EAAE,KAAK;EAAE,IAAI,EAAE,KAAK;;AAAI,SAAS;AACjH,kBAAmB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;AAClD,oBAAqB;EAAE,OAAO,EAAE,OAAO;;AAAI,SAAS;;;ACnBpD,uDAAU;EACR,OAAO,EAAE,KAAK;EACd,SAAS,EApBE,KAAK;EAqBhB,MAAM,EAAE,MAAM;EACd,OAAO,EAAE,MAAe;;AAE1B,0CAAoB;EAClB,UAAU,EAAE,OAAO;EAEnB,sDAAO;IACL,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,YAAY;IACrB,KAAK,EAAE,IAAI;;AAEf,gCAAW;EACT,cAAc,EAAE,SAAS;EACzB,cAAc,EAAE,KAAI;;AAItB,6CAAU;ECMN,WAAW,EAAE,SAA8C;EAC3D,QAAQ,EAAE,MAAM;EAChB,UAAU,EAAE,IAAI;EAShB,cAAc,EAAC,UAAU;;ADd7B,gCAAa;EEkCH,OAAO,EAAE,YAAyB;EAAlC,OAAO,EAAE,IAAyB;;AF9B5C,IAAI;EACF,WAAW,EAlCA,6DAA6D;EAmCxE,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;EAChB,sBAAsB,EAAE,WAAW;EAEnC,cAAW;IACT,aAAa,EAAE,SAAS;;;AAI5B,WAAW;EACT,eAAe,EAAE,IAAI;EACrB,KAAK,EAjDY,OAAkB;;AAmDrC,kBAAkB;EAChB,WAAW,EAAE,GAAG;EAChB,QAAQ,EAAE,QAAQ;EAClB,IAAI,EAAE,IAAI;EACV,YAAY,EAAE,GAAG;EAEjB,8EAAa;IACX,UAAU,EAAE,CAAC;EAEf,0NAAsC;IACpC,SAAS,EAAE,OAAO;IAClB,gSAAQ;MACN,QAAQ,EAAE,QAAQ;MAClB,IAAI,EAAE,CAAC;MACP,KAAK,EAAE,GAAG;MACV,OAAO,EAAE,GAAG;;AAElB,EAAE;EACA,WAAW,EAAE,GAAG;EAChB,KAAK,EAzEQ,OAAe;EA2E5B,aAAY;IACV,aAAa,EAAE,SAAS;;AAE5B,EAAE;EACA,MAAM,EAAE,YAAuB;EAC/B,KAAK,EA/EM,OAAe;EAgF1B,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;EAEhB,aAAY;IACV,aAAa,EAAE,SAAS;EAE1B,qBAAoB;IAClB,OAAO,EAAE,uBAAmC;IAC5C,iBAAiB,EAAE,SAAS;;AAEhC,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,SAAS,EAAE,IAAI;EAEf,aAAY;IACV,aAAa,EAAE,SAAS;EAE1B,qBAAoB;IAClB,OAAO,EAAE,8CAA0D;IACnE,iBAAiB,EAAE,SAAS;;AAEhC,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,SAAS,EAAE,IAAI;EAEf,aAAY;IACV,aAAa,EAAE,SAAS;EAE1B,qBAAoB;IAClB,OAAO,EAAE,qEAAiF;IAC1F,iBAAiB,EAAE,SAAS;;AAEhC,EAAE;EACA,MAAM,EAAE,aAAa;EACrB,WAAW,EAAE,GAAG;EAChB,SAAS,EAAE,OAAO;EAElB,qBAAoB;IAClB,OAAO,EAAE,4FAAwG;IACjH,iBAAiB,EAAE,SAAS;EAE9B,OAAI;IACF,WAAW,EAAE,GAAG;;AAEpB,QAAQ;EACN,WAAW,EAAE,MAAM;EACnB,MAAM,EAAE,UAAU;;AAEpB,EAAE;EACA,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,GAAG;;AAEpB,CAAC;EACC,KAAK,EArIM,OAAe;;AAuI5B,iBAAiB;EACf,MAAM,EAAE,MAAM;EACd,OAAO,EAAE,mBAAmB;EAC5B,aAAa,EApIM,GAAG;EAqItB,KAAK,EAAE,IAAyB;EAChC,UAAU,EAAE,sBAAuB;EACnC,MAAM,EAAE,iBAA2B;EAEnC,2BAAI;IACF,UAAU,EAAE,kBAAkB;EAEhC,qBAAC;IACC,aAAa,EAAE,GAAG;EAEpB,2CAAY;IACV,aAAa,EAAE,CAAC;;AAEpB,mBAAmB;EACjB,OAAO,EAAE,OAAO;EAChB,UAAU,EAAE,mBAAmB;EAC/B,WAAW,EAAE,MAAM;;AAErB,IAAI;EACF,WAAW,EAAE,OAAO;;AAEtB,OAAO;EACL,UAAU,EAAE,MAAM;;;AAIpB,SAAS;EACP,WAAW,EAAE,GAAG;EAChB,UAAU,EAxKG,OAAe;EAyK5B,aAAa,EAAE,iBAA2B;EAK1C,YAAE;IGiKF,uBAAwC,EH/JrB,aAAa;IG+JhC,eAAwC,EH/JrB,aAAa;IAC9B,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,WAAW;IAEpB,oCAAiD;MAPnD,YAAE;QGiKF,sBAAwC,EHzJpB,MAAM;QGyJ1B,cAAwC,EHzJpB,MAAM;QACtB,UAAU,EAAE,MAAM;EAEtB,YAAE;IGsJF,YAAwC,EHrJhC,QAAQ;IGqJhB,IAAwC,EHrJhC,QAAQ;EAEhB,WAAC;IACC,eAAe,EAAE,IAAI;IACrB,WAAW,EAAE,GAAG;IAChB,KAAK,EAAE,KAAK;IACZ,cAAc,EAAE,KAAI;EAGpB,mBAAC;IACC,WAAW,EAAE,GAAG;IAChB,cAAc,EAAE,KAAI;EAExB,wBAAc;IACZ,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,OAAO;IAChB,gBAAgB,EAAE,OAAyB;IAC3C,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,KAAK,EAAE,KAAK;IACZ,aAAa,EAvMI,GAAG;IAwMpB,QAAQ,EAAE,QAAQ;IAClB,GAAG,EAAE,IAAI;IAET,gCAAO;MAEL,cAAc,EAAE,kBAAkB;;;AAMtC,eAAQ;EACN,OAAO,EAAE,cAAuB;EAChC,UAAU,EAxNG,OAAkB;EAyN/B,aAAa,EAAE,iBAA2B;AAE5C,kBAAW;EAET,UAAU,EAAE,MAAM;EAClB,MAAM,EAAE,KAAK;EACb,MAAM,EAAE,CAAC;EACT,OAAO,EAAE,CAAC;EACV,IAAI,EAAE,IAAI;EACV,UAAU,EAAE,6CAA6C;EACzD,eAAe,EAAE,OAAO;AAE1B,SAAE;EACA,UAAU,EAAE,MAAM;EAClB,MAAM,EAAE,aAAa;EACrB,OAAO,EAAE,CAAC;EACV,IAAI,EAAE,CAAC;EACP,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,cAAc,EAAE,SAAS;AAE3B,kBAAW;EG6FX,mBAAwC,EH1FzB,MAAM;EG0FrB,WAAwC,EH1FzB,MAAM;EG0FrB,uBAAwC,EHzFrB,MAAM;EGyFzB,eAAwC,EHzFrB,MAAM;AAEzB,oBAAa;EACX,OAAO,EAAE,KAAK;EACd,MAAM,EAAE,QAAQ;EAChB,OAAO,EAAE,QAAQ;EACjB,aAAa,EArPI,GAAG;EAsPpB,MAAM,EAAE,iBAAyB;EACjC,UAAU,EAAE,KAAK;EACjB,eAAe,EAAE,IAAI;EACrB,UAAU,EAAE,MAAM;AAEpB,oBAAa;EACX,MAAM,EAAE,WAAW;EACnB,SAAS,EAAE,IAAI;EACf,UAAU,EAAE,MAAM;EAClB,QAAQ,EAAE,QAAQ;EAClB,GAAG,EAAE,IAAI;EACT,KAAK,EAvQI,OAAe;EAyQxB,sBAAC;IACC,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,CAAC;AAEb,oCAAiD;EAC/C,eAAQ;IACN,WAAW,EAAE,IAAI;IACjB,cAAc,EAAE,IAAI;EAEtB,SAAE;IACA,MAAM,EAAE,gBAAgB;IACxB,SAAS,EAAE,IAAI;EAEjB,kBAAW;IGwDb,sBAAwC,EHvDpB,MAAM;IGuD1B,cAAwC,EHvDpB,MAAM;;;AAK5B,MAAM;EACJ,OAAO,EAAE,MAAuB;EAChC,UAAU,EAAE,MAAM;EAClB,SAAS,EAAE,IAAI;EACf,KAAK,EAhSM,OAAe;EAkS1B,oBAAa;IACX,UAAU,EAAE,CAAC;IACb,aAAa,EAAE,CAAC;IAChB,WAAW,EAAE,CAAC;IAEd,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,iBAAyB;EAEvC,WAAI;IACF,OAAO,EAAE,YAAY;IACrB,cAAc,EAAE,MAAM;EAGtB,iBAAC;IACC,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,MAAK;EAElB,oBAAa;IAEX,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,QAAQ;IAClB,IAAI,EAAE,MAAK;IAEX,yBAAI;MAEF,KAAK,EAAE,CAAC;IAGV,sBAAC;MACC,KAAK,EAAE,GAAG;MACV,OAAO,EAAE,MAAK;MACd,OAAO,EAAE,YAAY;;;AAI3B,aAAa;EIvUX,QAAQ,EAAE,MAAM;ECiBd,KAAK,EAAE,CAAC;ELyTV,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,IAAI;;AAErB,QAAQ;EACN,KAAK,EAlVS,KAAK;EAmVnB,UAAU,EAAE,GAAG;EACf,KAAK,EAAE,IAAI;EAIX,WAAE;IACA,SAAS,EAAE,IAAI;IACf,gBAAgB,EAAE,KAAK;IACvB,OAAO,EAAE,CAAC;IACV,KAAK,EA5VO,KAAK;IA6VjB,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,GAAG;EAElB,iBAAQ;IACN,KAAK,EAjWO,KAAK;IAkWjB,UAAU,EAAE,IAAI;EAElB,gCAAuB;IACrB,KAAK,EAAE,KAAK;IACZ,aAAa,EAAE,IAAI;IACnB,OAAO,EAAE,IAAI;IACb,cAAc,EAAE,GAAG;IAEnB,sCAAK;MACH,OAAO,EAAE,IAAI;MACb,YAAY,EAAE,KAAI;IAEpB,gDAAe;MACb,cAAc,EAAE,GAAG;MACnB,SAAS,EAAE,CAAC;EAIhB,oCAAwE;IAnC1E,QAAQ;MA0CJ,KAAK,EAAE,IAAI;MACX,KAAK,EAAE,IAAI;MANX,4CAAmC;QACjC,OAAO,EAAE,IAAI;MAMf,YAAG;QACD,aAAa,EAAE,CAAC;MAIlB,gCAAuB;QACrB,KAAK,EAAE,IAAI;QACX,sCAAK;UACH,OAAO,EAAE,MAAM;;AAMvB,oCAAwE;EACtE,mBAAmB;IACjB,WAAW,EAAE,KAAqB;IAClC,YAAY,EAAE,mBAA0D;AAE5E,oCAAuE;EACrE,mBAAmB;IACjB,YAAY,EAAE,IAAI;;AAItB,iBAAiB;EACf,aAAa,EAAE,IAAI;EACnB,SAAS,EAAE,IAAI;EAEf,oBAAE;IACA,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;IAEV,0BAAK;MACH,OAAO,EAAE,UAAU;EAEvB,mBAAC;IACC,eAAe,EAAE,IAAI;IACrB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,KAAK;IAEd,yBAAO;MACL,KAAK,EAlaE,OAAe;;AAoa5B,2BAA2B;EACzB,OAAO,EAAE,SAAS;;;AAKpB,aAAa;EACX,aAAa,EAraM,GAAG;EAsatB,QAAQ,EAAE,QAAQ;EAClB,OAAO,EAAE,SAAS;EAClB,UAAU,EAAE,OAAO;EACnB,MAAM,EAAE,iBAAiB;EACzB,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,MAAM,EAAE,KAAK;EACb,WAAW,EAAE,gBAAgB;;;AAK7B,oCAAM;EACJ,OAAO,EAAE,MAAM;EACf,WAAW,EAAE,CAAC;AAEhB,wBAAS;EACP,OAAO,EAAE,KAAK;EACd,OAAO,EAAE,GAAG;EACZ,MAAM,EAAE,KAAI;AAEd,yBAAU;EACR,OAAO,EAAE,GAAO;EAChB,SAAS,EAAE,MAAM;EACjB,YAAY,EAAE,GAAG;EACjB,QAAQ,EAAE,QAAQ;EAClB,WAAW,EAAE,OAAM;EACnB,WAAW,EAAE,KAAK;;;AAMtB,gBAAgB;EACd,UAAU,EAvcI,GAAG;;AAycnB,6BAA6B;EAC3B,UAAU,EAAE,GAAG", +"sources": ["highlight.scss","fontello.scss","all.sass","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/typography/text/_replacement.scss","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/css3/_flexbox.scss","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/_support.scss","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/utilities/general/_clearfix.scss","../../../../../usr/local/lib/ruby/gems/2.7.0/gems/compass-core-1.0.3/stylesheets/compass/utilities/general/_hacks.scss"], "names": [], "file": "all.css" } \ No newline at end of file diff --git a/stylesheets/all.sass b/stylesheets/all.sass index e142db93b..c92cfe049 100644 --- a/stylesheets/all.sass +++ b/stylesheets/all.sass @@ -56,6 +56,9 @@ body line-height: 1.6 -webkit-font-smoothing: antialiased + &.spec_page + counter-reset: h2counter + /** Typography */ .headerlink @@ -74,34 +77,62 @@ h1, h2, h3, h4, h5 &:hover .headerlink, .headerlink:hover font-size: inherit &::after - margin-left: -.8em - width: .8em position: absolute + left: 0 + width: 1em content: "¶" h1 font-weight: 500 color: $color-accent + .spec_page & + counter-reset: h2counter + h2 margin: $h2-margin-top 0 15px 0 color: $color-main font-size: 22px line-height: 1.3 + .spec_page & + counter-reset: h3counter + + .spec_page &::before + content: counter(h2counter) "\0000a0\0000a0" + counter-increment: h2counter + h3 margin: 30px 0 15px 0 font-size: 18px + .spec_page & + counter-reset: h4counter + + .spec_page &::before + content: counter(h2counter) "." counter(h3counter) "\0000a0\0000a0" + counter-increment: h3counter + h4 margin: 20px 0 10px 0 font-size: 16px + .spec_page & + counter-reset: h5counter + + .spec_page &::before + content: counter(h2counter) "." counter(h3counter) "." counter(h4counter) "\0000a0\0000a0" + counter-increment: h4counter + h5 margin: 20px 0 10px 0 font-weight: 500 font-size: inherit + .spec_page &::before + content: counter(h2counter) "." counter(h3counter) "." counter(h4counter) "." counter(h5counter) "\0000a0\0000a0" + counter-increment: h5counter + code font-weight: 600 From 5c743a4e2a2c86f05e739a920504df6ff1c34888 Mon Sep 17 00:00:00 2001 From: Joel Alejandro Villarreal Bertoldi Date: Wed, 1 Sep 2021 07:38:46 -0300 Subject: [PATCH 08/93] Add Kurier as a Node.js implementation of JSON:API (#1569) * Add Kurier as a Node.js implementation of JSON:API * moved to the bottom of the list as requested --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index 706179c42..97bee22bb 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -206,6 +206,7 @@ and writing of JSON:API documents. * [DenaliJS](http://denalijs.org) A layered-conventions framework for building ambitious APIs. Includes a powerful addon system, best-in-class developer experience, and extensive documentation. * [jsonapi-fractal](https://github.com/andersondanilo/jsonapi-fractal) JSON:API Serializer inspired by Fractal (PHP) * [ts-japi](https://github.com/jun-sheaf/ts-japi) - A zero-dependency, highly-modular, js/ts-friendly, recursible, framework-agnostic library for serializing data to the JSON:API specification. Serializes the entire specification. +* [Kurier](https://github.com/kurierjs/kurier) is a TypeScript framework to create APIs following the [1.1 Spec of JSON:API](https://jsonapi.org/format/1.1/) + the [Operations proposal spec](https://github.com/json-api/json-api/blob/999e6df77b28549d6c37b163b73c8e9102400020/_format/1.1/index.md#operations). ### Ruby From 3475a3824d7fdcc92b926b4d9bc2c2d59b75350a Mon Sep 17 00:00:00 2001 From: Brad Jones Date: Tue, 14 Sep 2021 15:12:34 -0600 Subject: [PATCH 09/93] Add link to cursor pagination profile to profiles summary --- extensions/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/extensions/index.md b/extensions/index.md index 56010c1b3..e5b524fe6 100644 --- a/extensions/index.md +++ b/extensions/index.md @@ -62,11 +62,11 @@ is maintained on a best-effort basis. ## Profiles -There are no profiles at this time. - -- [Profile Example](https://example.com/profile/foo) - - URI: `https://example.com/profile/foo` - - Description: Lorem dolor sit amet. +- [Cursor Pagination](/profiles/ethanresnick/cursor-pagination) + - URI: `https://jsonapi.org/profiles/ethanresnick/cursor-pagination` + - Description: Cursor-based pagination (aka keyset pagination) is a + common pagination strategy that avoids many of the pitfalls of + "offset–limit" pagination. [extensions]: /format/1.1/#extensions [profiles]: /format/1.1/#profiles From 3332cc9dae0426e91dac95188e28637107694173 Mon Sep 17 00:00:00 2001 From: Philippe Vezina Date: Wed, 15 Sep 2021 16:29:02 -0400 Subject: [PATCH 10/93] Update index.md --- _format/1.0/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_format/1.0/index.md b/_format/1.0/index.md index 08469236d..25fffb8ef 100644 --- a/_format/1.0/index.md +++ b/_format/1.0/index.md @@ -20,7 +20,7 @@ for exchanging data. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 -[[RFC2119](http://tools.ietf.org/html/rfc2119)]. +[[RFC2119](https://tools.ietf.org/html/rfc2119)]. ## Content Negotiation From 100a3d1e14738d12b41dd0500699e3d8e2c47bff Mon Sep 17 00:00:00 2001 From: Per Date: Sun, 26 Sep 2021 14:51:04 +0200 Subject: [PATCH 11/93] add jsonapi-unwrapper to Ruby client libraries --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index 97bee22bb..496030e4c 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -86,6 +86,7 @@ isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and i * [SimpleJSONAPIClient](https://github.com/amcaplan/simple_jsonapi_client) gives you lower-level control for API operations, while your models and their relationships maintain a neat, ActiveRecord-inspired interface. * [jsonapi-simple_client](https://github.com/InspireNL/jsonapi-simple_client) a client to interact with a Server API that implements the JSON:API spec. * [jsonapi-record](https://github.com/InspireNL/jsonapi-record) a client framework for interacting JSON:API Spec compliant APIs in Ruby. +* [jsonapi-unwrapper](https://github.com/Sonberg/jsonapi-unwrapper) a simple and lightweight library to deserialize JSON:API payloads. ### PHP From 55e3c43a7c24985e5e980f7946058c41d3c11292 Mon Sep 17 00:00:00 2001 From: Timothy Stone Date: Fri, 15 Oct 2021 12:28:11 -0400 Subject: [PATCH 12/93] Remove redirect in link to PATCH RFC MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes #1588 In the FAQ, Where's PUT?, the link under PATCH points to an insecure location, e.g., http://tools.ietf.org/html/rfc5789 and results in two (2) redirects to the correct location. The correct URL, after redirection, is https://datatracker.ietf.org/doc/html/rfc5789 Moreover, this can sometimes result in a 404 from tools.ietf.org (which appears to be intermittent, possibly due to a server misconfiguration; the personal website for Henrik Levkowetz, and member of the IETF Tools Team, appeared at the root several times before starting to redirect, see response in issue 🤔 ). --- faq/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/faq/index.md b/faq/index.md index 5e8652c6a..e88354a42 100644 --- a/faq/index.md +++ b/faq/index.md @@ -62,7 +62,7 @@ non-standard actions they support. Feel free to Using PUT to partially update a resource (i.e. to change only some of its state) is not allowed by the -[HTTP specification](https://tools.ietf.org/html/rfc7231#section-4.3.4). +[HTTP specification](https://datatracker.ietf.org/doc/html/rfc7231#section-4.3.4). Instead, PUT is supposed to completely replace the state of a resource: > “The PUT method requests that the state of the target resource be **created @@ -70,7 +70,7 @@ Instead, PUT is supposed to completely replace the state of a resource: of a given representation would suggest that a subsequent GET on that same target resource will result in an equivalent representation being sent…” -The correct method for partial updates, therefore, is [PATCH](http://tools.ietf.org/html/rfc5789), +The correct method for partial updates, therefore, is [PATCH](https://datatracker.ietf.org/doc/html/rfc5789). which is what JSON:API uses. And because PATCH can also be used compliantly for full resource replacement, JSON:API hasn't needed to define any behavior for PUT so far. However, it may define PUT semantics in the future. From b17e007c4234191b5d2e0e5bafa3667d7b4fd3ef Mon Sep 17 00:00:00 2001 From: Timothy Stone Date: Mon, 18 Oct 2021 09:14:00 -0400 Subject: [PATCH 13/93] Correct the punctuation error `s/\./,` replace the full stop (`.`) with a comma (`,`) that snuck through proofreading. Co-authored-by: Jeldrik Hanschke --- faq/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/faq/index.md b/faq/index.md index e88354a42..10f42a867 100644 --- a/faq/index.md +++ b/faq/index.md @@ -70,7 +70,7 @@ Instead, PUT is supposed to completely replace the state of a resource: of a given representation would suggest that a subsequent GET on that same target resource will result in an equivalent representation being sent…” -The correct method for partial updates, therefore, is [PATCH](https://datatracker.ietf.org/doc/html/rfc5789). +The correct method for partial updates, therefore, is [PATCH](https://datatracker.ietf.org/doc/html/rfc5789), which is what JSON:API uses. And because PATCH can also be used compliantly for full resource replacement, JSON:API hasn't needed to define any behavior for PUT so far. However, it may define PUT semantics in the future. From 0f60d90234033b7bc5ff319ce86aff20d14d5e93 Mon Sep 17 00:00:00 2001 From: Marko Milos Date: Mon, 25 Oct 2021 16:11:41 +0200 Subject: [PATCH 14/93] Added library reference to Implementations page (#1585) * Update index.md Update for "Implementations" page (https://jsonapi.org/implementations/) Added reference for JSON:API library for Java/Kotlin built on top of Moshi from Square. Library added: https://github.com/MarkoMilos/jsonapi * Update implementations/index.md Fixed grammar for the library description Co-authored-by: Dan Gebhardt Co-authored-by: Dan Gebhardt --- implementations/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/implementations/index.md b/implementations/index.md index 496030e4c..d766b0268 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -112,7 +112,7 @@ isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and i * [crnk.io](http://www.crnk.io) is a JSON:API framework for clients and servers. On the client-side it targets both Java and Android development. As for the backend side a rich set of modules helps with the integration of various Java frameworks. - + * [jsonapi](https://github.com/MarkoMilos/jsonapi) Library for streamlined use of JSON:API using Kotlin and Java built on top of Moshi from Square. It is built with a powerful api and supports JVM (Java/Kotlin) and Android. Supporting deserialization and serialization it is meant to be used on both client and server side. ### Android * [faogustavo/JSONApi](https://github.com/faogustavo/JSONApi) library for deserializing automatic. It can be integrated with retrofit. It has some ideas from Morpheus and jsonapi-converter but has some aditionals. From 41baf41aeabac84476a1beff7e0d1781a941e65f Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Sun, 30 Jan 2022 11:11:55 +0100 Subject: [PATCH 15/93] Clarify query parameters for top-level self link In the past we have seen several questions regarding the top-level `self` link and if it should contain query parameters supplied by the client, which affected the response document. Adding an explicit note about it should help to prevent such confusion in the future. --- _format/1.1/index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 34877ce28..f74c4c3a6 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -319,6 +319,12 @@ The top-level [links object][links] **MAY** contain the following members: Schema) for the current document. * [pagination] links for the primary data. +> Note: The `self` link should contain the query parameters provided by the client +> to generate the current response document. This includes but is not limited to +> query parameters used for [inclusion of related resources][fetching resources], +> [sparse fieldsets][fetching sparse fieldsets], [sorting][fetching sorting], +> [pagination][fetching pagination] and [filtering][fetching filtering]. + The document's "primary data" is a representation of the resource or collection of resources targeted by a request. From 01aea64ce346040aa6ee53cd8cf220ed30c8167f Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Mon, 31 Jan 2022 18:31:07 +0100 Subject: [PATCH 16/93] Update _format/1.1/index.md Co-authored-by: Fred Drake --- _format/1.1/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index f74c4c3a6..28ae180a6 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -319,7 +319,7 @@ The top-level [links object][links] **MAY** contain the following members: Schema) for the current document. * [pagination] links for the primary data. -> Note: The `self` link should contain the query parameters provided by the client +> Note: The `self` link in the top-level `links` object must contain the query parameters provided by the client > to generate the current response document. This includes but is not limited to > query parameters used for [inclusion of related resources][fetching resources], > [sparse fieldsets][fetching sparse fieldsets], [sorting][fetching sorting], From 93660d6019a6c35f9118cc5bbdd755288688a75e Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Tue, 1 Feb 2022 22:10:56 +0100 Subject: [PATCH 17/93] rewritten to focus more on the intent --- _format/1.1/index.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 28ae180a6..8c5065e4a 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -319,9 +319,12 @@ The top-level [links object][links] **MAY** contain the following members: Schema) for the current document. * [pagination] links for the primary data. -> Note: The `self` link in the top-level `links` object must contain the query parameters provided by the client -> to generate the current response document. This includes but is not limited to -> query parameters used for [inclusion of related resources][fetching resources], +> Note: The `self` link in the top-level `links` object allows a client to +> refresh the data represented by the current response document. The client +> should be able to use the provided link without applying any additional +> information. Therefore the link must contain the query parameters provided +> by the client to generate the response document. This includes but is not +> limited to query parameters used for [inclusion of related resources][fetching resources], > [sparse fieldsets][fetching sparse fieldsets], [sorting][fetching sorting], > [pagination][fetching pagination] and [filtering][fetching filtering]. From 1bf9484174db7c2be801f4eccbc8cc0ac80edb75 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Mon, 21 Feb 2022 12:33:12 +0100 Subject: [PATCH 18/93] only client-requested sparse fieldsets are exception to full linkage requirement The current wording could be misunderstood that also fields excluded by the server if client does _not_ request a sparse fieldset are an exception for full linkage requirement. This changes clarifies that only exception is if a client _explicilty_ requested a sparse fieldset, which does not include a relationship required for full linkage. --- _format/1.1/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 8c5065e4a..b9fca2ed2 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -623,7 +623,8 @@ included without a direct or indirect relationship to the document's primary data. The only exception to the full linkage requirement is when relationship fields -that would otherwise contain linkage data are excluded via [sparse fieldsets](#fetching-sparse-fieldsets). +that would otherwise contain linkage data are excluded due to +[sparse fieldsets](#fetching-sparse-fieldsets) requested by the client. A complete example document with multiple included relationships: From d551663a522847ca9827f037cc07b9c27eface43 Mon Sep 17 00:00:00 2001 From: Rick Morice Date: Wed, 23 Mar 2022 10:47:40 +0000 Subject: [PATCH 19/93] Update index.md Applying to add new php library: https://github.com/floor9design-ltd/test-data-generator Info: * 100% unit tests * CI implemented * 6 use months in production environments in multiple projects * actively maintained --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index ac6da9dea..fe5723414 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -92,6 +92,7 @@ isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and i * [Art4 / json-api-client](https://github.com/Art4/json-api-client) is a library for validating and handling the response body in a simple OOP way. * [woohoolabs / yang](https://github.com/woohoolabs/yang) is a PSR-7 compatible library that is able to build and send requests, and handle responses. * [enm/json-api-client](https://eosnewmedia.github.io/JSON-API-Client/) is an abstract client-side PHP implementation of the json:api specification which is based on [enm/json-api-common](https://eosnewmedia.github.io/JSON-API-Common/). It allows you to send json:api requests via your own http client implementation or via a buzz or guzzle client. +* [floor9design-ltd/json-api-formatter](https://github.com/floor9design-ltd/json-api-formatter) An open source library designed to be used for generating and interacting with (making and receiving) JSON API requests. 100% unit tested and actively maintained by the author. Easy to use with frameworks such as Laravel/Symfony. * [swisnl/json-api-client](https://github.com/swisnl/json-api-client) Is a package for mapping remote {json:api} resources to Eloquent like models and collections. ### Dart From 621b260e616793b5320a4a2706a21047e6d249b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivica=20Batini=C4=87?= Date: Fri, 25 Mar 2022 14:05:58 +0100 Subject: [PATCH 20/93] Update "Value is too short" detail description Let's make this world a better place for everyone :D https://twitter.com/sqiouyilu/status/1495971335578832898 --- examples/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/index.md b/examples/index.md index 3f1c890c6..aafcbfa77 100644 --- a/examples/index.md +++ b/examples/index.md @@ -197,7 +197,7 @@ Content-Type: application/vnd.api+json "status": "422", "source": { "pointer": "/data/attributes/firstName" }, "title": "Invalid Attribute", - "detail": "First name must contain at least three characters." + "detail": "First name must contain at least two characters." } ] } @@ -263,7 +263,7 @@ Content-Type: application/vnd.api+json { "source": { "pointer": "/data/attributes/firstName" }, "title": "Invalid Attribute", - "detail": "First name must contain at least three characters." + "detail": "First name must contain at least two characters." }, { "source": { "pointer": "/data/attributes/firstName" }, @@ -309,7 +309,7 @@ Content-Type: application/vnd.api+json "code": "123", "source": { "pointer": "/data/attributes/firstName" }, "title": "Value is too short", - "detail": "First name must contain at least three characters." + "detail": "First name must contain at least two characters." }, { "code": "225", From e7d3a7ab61b45dc65162e97df43b04b38db1dab9 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Sat, 26 Mar 2022 08:52:03 +0100 Subject: [PATCH 21/93] clarify 409 even if only type or it does not match endpoint The server should respond with `409 Conflict` also of only `type` or `id` does not match the used. Using _and_ wasn't precise therefore. General speaking the server should respond with `409 Conflict` if resource object included in a `PATCH` request is _not_ the resource represented by the used endpoint. This issue was reported by @Relequestual in #1549. He also proposed the fix implemented here. Closes #1549 --- _format/1.1/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index b9fca2ed2..2eee94b90 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -1787,7 +1787,7 @@ update a resource if that update would violate other server-enforced constraints (such as a uniqueness constraint on a property other than `id`). A server **MUST** return `409 Conflict` when processing a `PATCH` request in -which the resource object's `type` and `id` do not match the server's endpoint. +which the resource object's `type` or `id` do not match the server's endpoint. A server **SHOULD** include error details and provide enough information to recognize the source of the conflict. From 9333eacde0b84586fb9f4846e1023be0be09aa1d Mon Sep 17 00:00:00 2001 From: Alex H Date: Sat, 2 Apr 2022 20:37:25 +0400 Subject: [PATCH 22/93] add nestjs-json-api plugin (#1594) * add nestjs-json-api plugin * short description Add stack which need to use * move from client to server part * Moved new lib to the end of its section Co-authored-by: Dan Gebhardt --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index fe5723414..b2e5224c2 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -208,6 +208,7 @@ and writing of JSON:API documents. * [jsonapi-fractal](https://github.com/andersondanilo/jsonapi-fractal) JSON:API Serializer inspired by Fractal (PHP) * [ts-japi](https://github.com/jun-sheaf/ts-japi) - A zero-dependency, highly-modular, js/ts-friendly, recursible, framework-agnostic library for serializing data to the JSON:API specification. Serializes the entire specification. * [Kurier](https://github.com/kurierjs/kurier) is a TypeScript framework to create APIs following the [1.1 Spec of JSON:API](https://jsonapi.org/format/1.1/) + the [Operations proposal spec](https://github.com/json-api/json-api/blob/999e6df77b28549d6c37b163b73c8e9102400020/_format/1.1/index.md#operations). +* [nestjs-json-api](https://github.com/ringcentral/nestjs-json-api) A module for NestJS and TypeORM to implement JSON API supporting features such as, end point, query params, body params, validation and transformation response. ### Ruby From 9626d34e98721da8258c1c1f0f81bb4be7fac9b0 Mon Sep 17 00:00:00 2001 From: Christopher Gammie Date: Sat, 2 Apr 2022 17:39:15 +0100 Subject: [PATCH 23/93] Update Laravel JSON:API package (#1593) --- implementations/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/implementations/index.md b/implementations/index.md index b2e5224c2..9dbf496b3 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -65,7 +65,7 @@ isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and i * [DatX](https://github.com/infinum/datx) is an opinionated data store for use with the MobX state management library that adds JSON:API support with [datx-jsonapi](https://github.com/infinum/datx/tree/master/packages/datx-jsonapi) mixin. * [jsonapi-fractal](https://github.com/andersondanilo/jsonapi-fractal) JSON:API Serializer inspired by Fractal (PHP) * [ts-japi](https://github.com/jun-sheaf/ts-japi) - A zero-dependency, highly-modular, js/ts-friendly, recursible, framework-agnostic library for serializing data to the JSON:API specification. Serializes the entire specification. -* [drupal-jsonapi-params](https://github.com/d34dman/drupal-jsonapi-params) A library for building query parameters when connecting with Drupal CMS's JSON:API. +* [drupal-jsonapi-params](https://github.com/d34dman/drupal-jsonapi-params) A library for building query parameters when connecting with Drupal CMS's JSON:API. ### iOS @@ -167,7 +167,7 @@ and writing of JSON:API documents. * [nilportugues / laravel5-jsonapi-transformer](https://github.com/nilportugues/laravel5-jsonapi-transformer) Laravel 5 JSON:API Transformer Package outputting valid API responses in JSON and JSON:API formats. * [tuyakhov / yii2-json-api](https://github.com/tuyakhov/yii2-json-api) Implementation of JSON:API specification for the Yii framework. * [json-api-php/json-api](https://github.com/json-api-php/json-api) An attempt to translate the JSON:API specification into a set of high quality unit/functional tests and implement it in PHP 7 strictly following TDD and SOLID OOP principles. -* [cloudcreativity/laravel-json-api](https://github.com/cloudcreativity/laravel-json-api) JSON:API (jsonapi.org) package for Laravel applications. This project extends cloudcreativity/json-api, adding in framework-specific features. +* [laravel-json-api/laravel](https://github.com/laravel-json-api/laravel) Laravel implementation of the JSON:API specification, with full feature support and extensive documentation. * [FriendsOfCake/crud-json-api](https://github.com/FriendsOfCake/crud-json-api) CakePHP Crud Listener for building maintainable JSON:API compliant APIs. * [thephpleague/fractal](http://fractal.thephpleague.com/) A partial implementation of the JSON:API spec allowing for an easy drop in JSON rendering solution. * [oligus/jad](https://github.com/oligus/jad) A library that turns doctrine entities into json:api resource, or collection of resources, automagically. From 9f47012e3b1134def4200d0a340a580144f3bb86 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Sat, 2 Apr 2022 18:41:25 +0200 Subject: [PATCH 24/93] Clarify that server should response with 400 Bad Request in both cases (#1616) --- _format/1.1/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 2eee94b90..fa0993e82 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -2105,7 +2105,7 @@ It is **RECOMMENDED** that a capital letter (e.g. camelCasing) be used to satisfy the above requirement. If a server encounters a query parameter that does not follow the naming -conventions above, and the server does not know how to process it as a query +conventions above, or the server does not know how to process it as a query parameter from this specification, it **MUST** return `400 Bad Request`. > Note: By forbidding the use of query parameters that contain only the characters From 40e51f82ec2b75724b6e9aa6e4af3a7dd8b4cd61 Mon Sep 17 00:00:00 2001 From: Daniel Compton Date: Sun, 3 Apr 2022 04:43:18 +1200 Subject: [PATCH 25/93] Clarify potentially confusing Retry-After value (#1385) The description for this http request talked about retrying sooner than 1 second with Retry-After: 0. Using a Retry-After value of 1 was slightly confusing, as it wasn't clear if this was a typo, or demonstrating the general retry case. This commit changes Retry-After to 10 seconds to clearly delineate it from the 0s-1s range. --- recommendations/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/recommendations/index.md b/recommendations/index.md index 1d52cf320..32903033d 100644 --- a/recommendations/index.md +++ b/recommendations/index.md @@ -239,7 +239,7 @@ Requests for still-pending jobs **SHOULD** return a status `200 OK`, as the serv ```http HTTP/1.1 200 OK Content-Type: application/vnd.api+json -Retry-After: 1 +Retry-After: 10 { "data": { From a9335994a51be3047ad7a61f34c63bee4191e798 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Sat, 2 Apr 2022 21:23:25 +0200 Subject: [PATCH 26/93] define relationship object explicitly (#1608) * define relationship object explicitly The specification uses the term "relationship object" without defining it first. It also does not specify that the name of a relationship is given by its key in the relationships object. This change addresses both. * Update _format/1.1/index.md Co-authored-by: Dan Gebhardt Co-authored-by: Dan Gebhardt --- _format/1.1/index.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index fa0993e82..eec5f016f 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -475,12 +475,15 @@ as attributes. Instead, [relationships] **SHOULD** be used. ##### Relationships The value of the `relationships` key **MUST** be an object (a "relationships -object"). Members of the relationships object ("relationships") represent -references from the [resource object][resource objects] in which it's defined to other resource -objects. +object"). Each member of a relationships object ("relationships") represents +a "relationship" from the [resource object][resource objects] +in which it has been defined to other resource objects. Relationships may be to-one or to-many. +A relationship's name is given by its key. The value at that key **MUST** be an +object ("relationship object"). + A "relationship object" **MUST** contain at least one of the following: From 3f20de7802d9baa43c780075c0dfb29b85a985ba Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Sat, 7 May 2022 07:29:47 -0400 Subject: [PATCH 27/93] add entry for kt.jsonapi (#1624) --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index 9dbf496b3..258056e6d 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -262,6 +262,7 @@ the moment. * [pydantic-jsonapi](https://github.com/DeanWay/pydantic-jsonapi) JSON:api validation with python type hinting using [pydantic](https://pydantic-docs.helpmanual.io/) * [Flask-Restless-NG](https://github.com/mrevutskyi/flask-restless-ng) Builds JSON:API from SQLAlchemy models using Flask * [starlette-jsonapi](https://github.com/vladmunteanu/starlette-jsonapi) Microframework on top of Starlette and marshmallow-jsonapi with support for asynchronous ORMs +* [kt.jsonapi](https://pypi.org/project/kt.jsonapi/) JSON:API response generation using the Zope Component Architecture. ### Go From 55f7bc82eeba655303dc6540cb9c3a49d21a95ab Mon Sep 17 00:00:00 2001 From: Stjepan Banek <54813411+stjepanbanek@users.noreply.github.com> Date: Sat, 7 May 2022 13:30:34 +0200 Subject: [PATCH 28/93] Add link and short description for JsonApiX (#1623) --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index 258056e6d..b890b7f91 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -119,6 +119,7 @@ isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and i * [moshi-jsonapi](https://github.com/kamikat/moshi-jsonapi) serialize/deserialize JSON:API v1.0 using fantistic Moshi API! With friendly Java interface and easy integration with Retrofit. * [Morpheus](https://github.com/xamoom/Morpheus) library for deserializing your resources with automatic mapping for relationships. Uses gson to map objects in attributes. * [Izzy JSONAPI parser](https://github.com/undabot/izzy-json-api-android) library for deserializing and serializing resources with support both for Gson and Jackson parsers. It also has simple Retrofit integration. +* [JsonApiX](https://github.com/infinum/kotlin-jsonapix) annotation processor library for serializing and deserializing Kotlin classes. It's easy to use - setup only requires annotating classes. Retrofit integration is included. ### R From f901c574c0386a5a5cd54e5325f3ec272c1406e5 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Fri, 10 Jun 2022 13:55:56 +0200 Subject: [PATCH 29/93] Clarify handling of Accept header with media type parameter other than ext or profile (#1609) * Clarify handling of Accept header with media type parameter other than ext or profile This clarifies how server should handle media types in `Accept` handler, which contains other media type parameters than `ext` or `profile`. So far the specification only specified the case if _all_ media types are modified by parameters other than `ext` and `profile`. But it didn't specified how an `Accept` header should be handled if only _some_ media types contained parameters other than `ext` and `profile`. Let's take this example: ```http Accept: application/vnd.api+json, application/vnd.api+json; ext="https://jsonapi.org/ext/version"; other="not allowed" ``` How should it handle the `application/vnd.api+json; ext="https://jsonapi.org/ext/version"; other="not allowed"` media type? Responding with a `406 Not Acceptable` to the request would not be appreciate because the request contains one media type without any media type parameter (`application/vnd.api+json`). Should the server apply the `https://jsonapi.org/ext/version` extension? Or should it ignore the media type all together because it contains one media type parameter, which is not allowed (`other="not allowed"`)? This change clarifies that server should ignore a media type if it is modified by parameters other than `ext` and `profile`. This is inline with the rule to reject the entire request if _all_ media types are modified by parameter other than `ext` and `profile`. It wouldn't make much sense, to reject a media type with a parameter other than `ext` and `profile` if it is the only one but use it if there is one other. * Update _format/1.1/index.md * "modified by" instead of "modified with" --- _format/1.1/index.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index eec5f016f..e07923cfc 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -241,11 +241,13 @@ with a `415 Unsupported Media Type` status code. `profile` media type parameter is present. If a request's `Accept` header contains an instance of the JSON:API media type, -servers **MUST** respond with a `406 Not Acceptable` status code if all -instances of that media type are modified with a media type parameter other -than `ext` or `profile`. If every instance of that media type is modified by the -`ext` parameter and each contains at least one unsupported extension URI, the -server **MUST** also respond with a `406 Not Acceptable`. +servers **MUST** ignore instances of that media type which are modified by a +media type parameter other than `ext` or `profile`. If all instances of that +media type are modified with a media type parameter other than `ext` or `profile`, +servers **MUST** respond with a `406 Not Acceptable` status code. If every +instance of that media type is modified by the `ext` parameter and each contains +at least one unsupported extension URI, the server **MUST** also respond with a +`406 Not Acceptable`. If the `profile` parameter is received, a server **SHOULD** attempt to apply any requested profile(s) to its response. A server **MUST** ignore any profiles From f1a2fcde71c741614b3819f3887f7f2a3822c3e8 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Fri, 10 Jun 2022 14:00:21 +0200 Subject: [PATCH 30/93] Clarify processing rules for malformed `ext` and `profile` members of JSON:API object (#1607) * Clarify processing rules for malformed `ext` and `profile` members of JSON:API object The applied extension and profiles must be provided as `ext` and `profile` media type parameters of `Content-Type` header. Additionally they may be listed as `jsonapi.ext` and `jsonapi.profile` member of a JSON:API document. This opens up the possibility of having different values in both places. So far the specification has not defined processing rules for such malformed documents. This clarifies that a client and server must honor the `Content-Type` header in case of a conflict. Additionally it clarifies that they should not reject the document but ignore the invalid `jsonapi.ext` and/or `jsonapi.profile` members. Ignoring them in case of a conflict rather than rejecting the document allows server and clients to _not_ process them at all - even if present. This avoids computing overhead just for the sake of validating the document. * Update _format/1.1/index.md Co-authored-by: Jeldrik Hanschke * Update _format/1.1/index.md Co-authored-by: Dan Gebhardt --- _format/1.1/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index e07923cfc..62809e0ea 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -831,6 +831,10 @@ The jsonapi object **MAY** contain any of the following members: * `profile` - an array of URIs for all applied [profiles]. * `meta` - a [meta] object that contains non-standard meta-information. +Clients and servers **MUST NOT** use an `ext` or `profile` member for content +negotiation. Content negotiation **MUST** only happen based on media type +parameters in `Content-Type` header. + A simple example appears below: ```json From e4b19197d419f9d8489c5ab054e15c67c11be8c1 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Fri, 10 Jun 2022 18:38:54 +0200 Subject: [PATCH 31/93] Fix inconsitency between general processing rules and pagination links (#1606) * Fix inconsitency between general processing rules and pagination links `null` value was not listed as an allowed value for links in general processing rules for links objects. But it was allowed explicitly for pagination links. This change fixes that inconsitency by allowing `null` for _every_ link to indicate that it does not exist. * Update _format/1.1/index.md --- _format/1.1/index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 62809e0ea..de094a149 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -758,8 +758,9 @@ of this member **MUST** be an object (a "links object"). Within this object, a link **MUST** be represented as either: * a string whose value is a URI-reference [[RFC3986 Section 4.1](https://tools.ietf.org/html/rfc3986#section-4.1)] - pointing to the link's target. -* a [link object]. + pointing to the link's target, +* a [link object] or +* `null` if the link does not exist. A link's relation type **SHOULD** be inferred from the name of the link unless the link is a [link object] and the link object has a `rel` member. From adc530bf07a2fe7df00293021881ec84fbd16a43 Mon Sep 17 00:00:00 2001 From: Benjamin Fleischer Date: Fri, 10 Jun 2022 15:32:59 -0500 Subject: [PATCH 32/93] Better multiple related resources request example (#1227) * Better multiple related resources request example > GET /articles/1?include=author,comments.author is confusing since `author` and `comments.author` both reference the `author` resource', but with different meaning. It looks a lot like GET /users/1?include=articles,articles.comments which is identical to GET /users/1?include=articles.comments since full linkage requires intermediate resources to be returned So, I've changed the the related resources to be more obviously different * Update _format/1.0/index.md Co-authored-by: Jeldrik Hanschke Co-authored-by: Dan Gebhardt Co-authored-by: Jeldrik Hanschke --- _format/1.0/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_format/1.0/index.md b/_format/1.0/index.md index 25fffb8ef..20e3525f6 100644 --- a/_format/1.0/index.md +++ b/_format/1.0/index.md @@ -973,7 +973,7 @@ resources. Multiple related resources can be requested in a comma-separated list: ```http -GET /articles/1?include=author,comments.author HTTP/1.1 +GET /articles/1?include=comments.author,ratings HTTP/1.1 Accept: application/vnd.api+json ``` From f77fdc2e923408faec02c270fd04842245a7b8f9 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Mon, 13 Jun 2022 21:25:40 +0200 Subject: [PATCH 33/93] Port "Better multiple related resources request example" to v1.1 (#1629) --- _format/1.1/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index de094a149..f09128848 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -1295,7 +1295,7 @@ documents without including potentially unwanted intermediate resources. Multiple related resources can be requested in a comma-separated list: ```http -GET /articles/1?include=author,comments.author HTTP/1.1 +GET /articles/1?include=comments.author,ratings HTTP/1.1 Accept: application/vnd.api+json ``` From df456f3ea783c59c5626a11047e8186ba6b6c1ee Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Mon, 13 Jun 2022 21:28:55 +0200 Subject: [PATCH 34/93] drop constraints on attribute values (#1630) --- _format/1.1/index.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index f09128848..eba129c82 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -462,12 +462,8 @@ The value of the `attributes` key **MUST** be an object (an "attributes object"). Members of the attributes object ("attributes") represent information about the [resource object][resource objects] in which it's defined. -Attributes may contain any valid JSON value. - -Complex data structures involving JSON objects and arrays are allowed as -attribute values. However, any object that constitutes or is contained in an -attribute **MUST NOT** contain a `relationships` or `links` member, as those -members are reserved by this specification for future use. +Attributes may contain any valid JSON value, including complex data structures +involving JSON objects and arrays. Keys that reference related resources (e.g. `author_id`) **SHOULD NOT** appear as attributes. Instead, [relationships] **SHOULD** be used. From 25c69821f0cfb2fef1fb14aaff6f6bd9add5f91c Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Mon, 27 Jun 2022 14:15:23 -0400 Subject: [PATCH 35/93] Clarify @-Members as implementation semantics (#1639) Eliminate confusion about interpreting @-Members anywhere in a document. --- _format/1.1/index.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index eba129c82..4fb913ca9 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -927,17 +927,15 @@ The following characters **MUST NOT** be used in implementation and Member names **MAY** also begin with an at sign (U+0040 COMMERCIAL AT, "@"). Members named this way are called "@-Members". @-Members **MAY** appear -anywhere in a JSON:API document. - -However, JSON:API processors **MUST** completely ignore @-Members (i.e. not -treat them as JSON:API data). - -Moreover, the existence of @-Members **MUST** be ignored when interpreting all -JSON:API definitions and processing instructions given outside of this -subsection. For example, an [attribute][attributes] is defined above as any -member of the attributes object. However, because @-Members must be ignored -when interpreting that definition, an @-Member that occurs in an attributes -object is not an attribute. +anywhere in a document. + +This specification provides no guidance on the meaning or usage of @-Members, +which are considered to be [implementation semantics](#semantics). @-Members +**MUST** be ignored when interpreting this specification's definitions and +processing instructions given outside of this subsection. For example, an +[attribute][attributes] is defined above as any member of the attributes object. +However, because @-Members must be ignored when interpreting that definition, an +@-Member that occurs in an attributes object is not an attribute. > Note: Among other things, "@" members can be used to add JSON-LD data to a JSON:API document. Such documents should be served with [an extra header](http://www.w3.org/TR/json-ld/#interpreting-json-as-json-ld) From 0f856785b9db264f153bd4cab5c73b0543de95d5 Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Tue, 12 Jul 2022 14:35:14 -0400 Subject: [PATCH 36/93] Standardize and clarify success (2xx) responses (#1638) --- _format/1.1/index.md | 113 ++++++++++++++++++++++--------------------- 1 file changed, 59 insertions(+), 54 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 4fb913ca9..d895b1963 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -1531,17 +1531,15 @@ to create a resource with a client-generated ID. ##### 201 Created -If a `POST` request did not include a [Client-Generated -ID](#crud-creating-client-ids) and the requested resource has been created -successfully, the server **MUST** return a `201 Created` status code. +If the requested resource has been created successfully and the server changes +the resource in any way (for example, by assigning an `id`), the server **MUST** +return a `201 Created` response and a document that contains the resource as +primary data. The response **SHOULD** include a `Location` header identifying the location of the newly created resource, in order to comply with [RFC 7231](http://tools.ietf.org/html/rfc7231#section-6.3.2). -The response **MUST** also include a document that contains the primary -resource created. - If the [resource object][resource objects] returned by the response contains a `self` key in its `links` member and a `Location` header is provided, the value of the `self` member **MUST** match the value of the `Location` header. @@ -1566,6 +1564,15 @@ Content-Type: application/vnd.api+json } ``` +A server **MAY** return a `201 Created` response with a document that contains +no primary data if the requested resource has been created successfully and the +server does not change the resource in any way (for example, by assigning an +`id` or `createdAt` attribute). Other top-level members, such as [meta], could +be included in the response document. + +> Note: Only servers that accept [Client-Generated +IDs](#crud-creating-client-ids) can avoid assigning an `id` to a new resource. + ##### 202 Accepted If a request to create a resource has been accepted for processing, but the @@ -1574,15 +1581,11 @@ server **MUST** return a `202 Accepted` status code. ##### 204 No Content -If a `POST` request *did* include a [Client-Generated -ID](#crud-creating-client-ids) and the requested resource has been created -successfully, the server **MUST** return either a `201 Created` status code -and response document (as described above) or a `204 No Content` status code -with no response document. - -> Note: If a `204` response is received the client should consider the resource -object sent in the request to be accepted by the server, as if the server -had returned it back in a `201` response. +If the requested resource has been created successfully and the server does not +change the resource in any way (for example, by assigning an `id` or `createdAt` +attribute), the server **MUST** return either a `201 Created` status code and +response document (as described above) or a `204 No Content` status code with no +response document. ##### 403 Forbidden @@ -1745,31 +1748,30 @@ does not want to allow deletion of records the client has not seen. #### Responses +##### 200 OK + +If a server accepts an update but also changes the targeted resource(s) in ways +other than those specified by the request (for example, updating the +`updatedAt` attribute or a computed `sha`), it **MUST** return a `200 OK` +response and a document that contains the updated resource(s) as primary data. + +A server **MAY** return a `200 OK` response with a document that contains no +primary data if an update is successful and the server does not change the +targeted resource(s) in ways other than those specified by the request. Other +top-level members, such as [meta], could be included in the response document. + ##### 202 Accepted If an update request has been accepted for processing, but the processing has not been completed by the time the server responds, the server **MUST** return a `202 Accepted` status code. -##### 200 OK - -If a server accepts an update but also changes the resource(s) in ways other -than those specified by the request (for example, updating the `updated-at` -attribute or a computed `sha`), it **MUST** return a `200 OK` response. The -response document **MUST** include a representation of the updated -resource(s) as if a `GET` request was made to the request URL. - -A server **MUST** return a `200 OK` status code if an update is successful, -the client's current fields remain up to date, and the server responds only -with top-level [meta] data. In this case the server **MUST NOT** include a -representation of the updated resource(s). - ##### 204 No Content -If an update is successful and the server doesn't update any fields besides -those provided, the server **MUST** return either a `200 OK` status code and -response document (as described above) or a `204 No Content` status code with no -response document. +If an update is successful and the server doesn't change the targeted +resource(s) in ways other than those specified by the request, the server +**MUST** return either a `200 OK` status code and response document (as +described above) or a `204 No Content` status code with no response document. ##### 403 Forbidden @@ -1968,6 +1970,18 @@ server, and we are defining its semantics for JSON:API. #### Responses +##### 200 OK + +If a server accepts an update but also changes the targeted relationship in +other ways than those specified by the request, it **MUST** return a `200 OK` +response and a document that includes the updated relationship data as its +primary data. + +A server **MAY** return a `200 OK` response with a document that contains no +primary data if an update is successful and the server does not change the +targeted relationship in ways other than those specified by the request. Other +top-level members, such as [meta], could be included in the response document. + ##### 202 Accepted If a relationship update request has been accepted for processing, but the @@ -1976,9 +1990,10 @@ server **MUST** return a `202 Accepted` status code. ##### 204 No Content -A server **MUST** return a `204 No Content` status code if an update is -successful and the representation of the resource in the request matches the -result. +If an update is successful and the server doesn't change the targeted +relationship in ways other than those specified by the request, the server +**MUST** return either a `200 OK` status code and response document (as +described above) or a `204 No Content` status code with no response document. > Note: This is the appropriate response to a `POST` request sent to a URL from a to-many [relationship link][relationships] when that relationship already @@ -1986,18 +2001,6 @@ exists. It is also the appropriate response to a `DELETE` request sent to a URL from a to-many [relationship link][relationships] when that relationship does not exist. -##### 200 OK - -If a server accepts an update but also changes the targeted relationship(s) -in other ways than those specified by the request, it **MUST** return a `200 -OK` response. The response document **MUST** include a representation of the -updated relationship(s). - -A server **MUST** return a `200 OK` status code if an update is successful, -the client's current data remain up to date, and the server responds -only with top-level [meta] data. In this case the server **MUST NOT** -include a representation of the updated relationship(s). - ##### 403 Forbidden A server **MUST** return `403 Forbidden` in response to an unsupported request @@ -2025,6 +2028,12 @@ Accept: application/vnd.api+json #### Responses +##### 200 OK + +A server **MAY** return a `200 OK` response with a document that contains no +primary data if a deletion request is successful. Other top-level members, such +as [meta], could be included in the response document. + ##### 202 Accepted If a deletion request has been accepted for processing, but the processing has @@ -2033,13 +2042,9 @@ return a `202 Accepted` status code. ##### 204 No Content -A server **MUST** return a `204 No Content` status code if a deletion -request is successful and no content is returned. - -##### 200 OK - -A server **MUST** return a `200 OK` status code if a deletion request is -successful and the server responds with only top-level [meta] data. +If a deletion request is successful, the server **MUST** return either a `200 +OK` status code and response document (as described above) or a `204 No Content` +status code with no response document. ##### 404 NOT FOUND From 8a07c182d3685553d4a008bd05378519959889bd Mon Sep 17 00:00:00 2001 From: Marty <29218982+mmammel12@users.noreply.github.com> Date: Fri, 15 Jul 2022 13:32:49 -0500 Subject: [PATCH 37/93] fix broken RFC 3986 link (#1641) --- _format/1.0/index.md | 2 +- _format/1.1/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_format/1.0/index.md b/_format/1.0/index.md index 20e3525f6..ecb83f24b 100644 --- a/_format/1.0/index.md +++ b/_format/1.0/index.md @@ -579,7 +579,7 @@ by clients and servers, and they **MUST** meet all of the following conditions: as defined below. To enable an easy mapping of member names to URLs, it is **RECOMMENDED** that -member names use only non-reserved, URL safe characters specified in [RFC 3986](http://tools.ietf.org/html/rfc3986#page-13). +member names use only non-reserved, URL safe characters specified in [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-2.3). #### Allowed Characters diff --git a/_format/1.1/index.md b/_format/1.1/index.md index d895b1963..6b895194f 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -867,7 +867,7 @@ meet all of the following conditions: as defined below. To enable an easy mapping of member names to URLs, it is **RECOMMENDED** that -member names use only non-reserved, URL safe characters specified in [RFC 3986](http://tools.ietf.org/html/rfc3986#page-13). +member names use only non-reserved, URL safe characters specified in [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-2.3). #### Allowed Characters From cd77524a6d72ad7254827e7322f1ffb270977217 Mon Sep 17 00:00:00 2001 From: Suren Khorenyan Date: Fri, 22 Jul 2022 22:42:48 +0300 Subject: [PATCH 38/93] Add Flask-COMBO-JSONAPI to Python Server libraries (#1634) --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index b890b7f91..34212ff28 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -264,6 +264,7 @@ the moment. * [Flask-Restless-NG](https://github.com/mrevutskyi/flask-restless-ng) Builds JSON:API from SQLAlchemy models using Flask * [starlette-jsonapi](https://github.com/vladmunteanu/starlette-jsonapi) Microframework on top of Starlette and marshmallow-jsonapi with support for asynchronous ORMs * [kt.jsonapi](https://pypi.org/project/kt.jsonapi/) JSON:API response generation using the Zope Component Architecture. +* [Flask-COMBO-JSONAPI](https://github.com/AdCombo/flask-combo-jsonapi) JSON:API flask extension for building REST APIs. ### Go From ebd2b4717cf4fb698a52d710dd3a94266748377b Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Wed, 27 Jul 2022 14:14:28 +0200 Subject: [PATCH 39/93] only top-level member may be defined by extension (#1642) * only top-level member may be defined by extension * Update _format/1.1/index.md Co-authored-by: Dan Gebhardt Co-authored-by: Dan Gebhardt --- _format/1.1/index.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 6b895194f..1e361531a 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -292,16 +292,17 @@ document containing data. This object defines a document's "top level". A document **MUST** contain at least one of the following top-level members: -* `data`: the document's "primary data" -* `errors`: an array of [error objects](#errors) +* `data`: the document's "primary data". +* `errors`: an array of [error objects](#errors). * `meta`: a [meta object][meta] that contains non-standard meta-information. +* a member defined by an applied [extension](#extensions). The members `data` and `errors` **MUST NOT** coexist in the same document. A document **MAY** contain any of these top-level members: -* `jsonapi`: an object describing the server's implementation +* `jsonapi`: an object describing the server's implementation. * `links`: a [links object][links] related to the primary data. * `included`: an array of [resource objects] that are related to the primary data and/or each other ("included resources"). From 87896c8c1fc6c697a56891463e93c979ba2f2aa7 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Fri, 29 Jul 2022 20:21:25 +0200 Subject: [PATCH 40/93] allow extension defined members as only member of relationship object (#1644) --- _format/1.1/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 1e361531a..5b0b06481 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -498,6 +498,7 @@ A "relationship object" **MUST** contain at least one of the following: * `data`: [resource linkage] * `meta`: a [meta object][meta] that contains non-standard meta-information about the relationship. +* a member defined by an applied [extension](#extensions). A relationship object that represents a to-many relationship **MAY** also contain [pagination] links under the `links` member, as described below. Any From e7d9320b15621d926230a948a858e13619067a83 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Mon, 1 Aug 2022 14:37:54 +0200 Subject: [PATCH 41/93] brackets are used in all query parameter families (#1647) --- _format/1.1/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 5b0b06481..dbef94cba 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -895,8 +895,8 @@ The following characters **MUST NOT** be used in implementation and - U+002B PLUS SIGN, "+" _(has overloaded meaning in URL query strings)_ - U+002C COMMA, "," _(used as a separator between relationship paths)_ - U+002E PERIOD, "." _(used as a separator within relationship paths)_ -- U+005B LEFT SQUARE BRACKET, "[" _(used in sparse fieldsets)_ -- U+005D RIGHT SQUARE BRACKET, "]" _(used in sparse fieldsets)_ +- U+005B LEFT SQUARE BRACKET, "[" _(used in query parameter families)_ +- U+005D RIGHT SQUARE BRACKET, "]" _(used in query parameter families)_ - U+0021 EXCLAMATION MARK, "!" - U+0022 QUOTATION MARK, '"' - U+0023 NUMBER SIGN, "#" From fe2909bb898adeaff6095606a0545dd37304325a Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Mon, 1 Aug 2022 14:39:41 +0200 Subject: [PATCH 42/93] update can only target a single resource (#1648) --- _format/1.1/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index dbef94cba..01d19a977 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -1752,14 +1752,14 @@ does not want to allow deletion of records the client has not seen. ##### 200 OK -If a server accepts an update but also changes the targeted resource(s) in ways +If a server accepts an update but also changes the targeted resource in ways other than those specified by the request (for example, updating the `updatedAt` attribute or a computed `sha`), it **MUST** return a `200 OK` -response and a document that contains the updated resource(s) as primary data. +response and a document that contains the updated resource as primary data. A server **MAY** return a `200 OK` response with a document that contains no primary data if an update is successful and the server does not change the -targeted resource(s) in ways other than those specified by the request. Other +targeted resource in ways other than those specified by the request. Other top-level members, such as [meta], could be included in the response document. ##### 202 Accepted @@ -1771,7 +1771,7 @@ return a `202 Accepted` status code. ##### 204 No Content If an update is successful and the server doesn't change the targeted -resource(s) in ways other than those specified by the request, the server +resource in ways other than those specified by the request, the server **MUST** return either a `200 OK` status code and response document (as described above) or a `204 No Content` status code with no response document. From e4c880c386669a2b03280b242a95832eedb8f2c5 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Wed, 3 Aug 2022 15:36:00 +0200 Subject: [PATCH 43/93] align wording for deleting resources with creating and updating (#1651) * align wording for deleting resources with creating and updating * align wording for resource's self URL with updating chapter * remove italic style not used for creating and updating * Update _format/1.1/index.md --- _format/1.1/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 01d19a977..1741b6877 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -2020,8 +2020,8 @@ responses, in accordance with ### Deleting Resources -An individual resource can be *deleted* by making a `DELETE` request to the -resource's URL: +A resource can be deleted by sending a `DELETE` request to the URL +that represents the resource: ```http DELETE /photos/1 HTTP/1.1 From 061bfd6ab681d97c15d0770e79fa2588884bf237 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Wed, 3 Aug 2022 15:39:07 +0200 Subject: [PATCH 44/93] support extension usage for relationship links (#1650) --- _format/1.1/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 1741b6877..b0f406e72 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -1831,8 +1831,8 @@ relationship is deleted (as a garbage collection measure). #### Updating To-One Relationships -A server **MUST** respond to `PATCH` requests to a URL from a to-one -[relationship link][relationships] as described below. +A to-one relationship can be updated by sending a `PATCH` request to a URL +from a to-one [relationship link][relationships]. The `PATCH` request **MUST** include a top-level member named `data` containing one of: @@ -1869,8 +1869,8 @@ a successful response. #### Updating To-Many Relationships -A server **MUST** respond to `PATCH`, `POST`, and `DELETE` requests to a -URL from a to-many [relationship link][relationships] as described below. +A to-many relationship can be updated by sending a `PATCH`, `POST`, or +`DELETE` request to a URL from a to-many [relationship link][relationships]. For all request types, the body **MUST** contain a `data` member whose value is an empty array or an array of [resource identifier objects][resource identifier object]. From f9e4e0e13d8d1005228878e7d03f833adbea4042 Mon Sep 17 00:00:00 2001 From: Dmitry Pimonov Date: Mon, 15 Aug 2022 13:50:13 +0300 Subject: [PATCH 45/93] Add EntityStore.TS to TypeScript client libraries (#1652) --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index 34212ff28..5647d62b7 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -66,6 +66,7 @@ isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and i * [jsonapi-fractal](https://github.com/andersondanilo/jsonapi-fractal) JSON:API Serializer inspired by Fractal (PHP) * [ts-japi](https://github.com/jun-sheaf/ts-japi) - A zero-dependency, highly-modular, js/ts-friendly, recursible, framework-agnostic library for serializing data to the JSON:API specification. Serializes the entire specification. * [drupal-jsonapi-params](https://github.com/d34dman/drupal-jsonapi-params) A library for building query parameters when connecting with Drupal CMS's JSON:API. +* [EntityStore.TS](https://github.com/dipscope/EntityStore.TS) - ORM like abstraction layer for TypeScript which includes extensible [provider](https://github.com/dipscope/JsonApiEntityProvider.TS) for accessing JSON:API servers. ### iOS From 07645e5218a00041fa2d77f3d488f31fb0be219a Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Mon, 22 Aug 2022 19:10:41 +0200 Subject: [PATCH 46/93] allow extension defined member as only member in links object of relationship object (#1658) --- _format/1.1/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index b0f406e72..236dbc9fe 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -495,6 +495,7 @@ A "relationship object" **MUST** contain at least one of the following: for the related resources as its primary data. (See [Fetching Relationships](#fetching-relationships).) * `related`: a [related resource link] + * a member defined by an applied [extension](#extensions). * `data`: [resource linkage] * `meta`: a [meta object][meta] that contains non-standard meta-information about the relationship. From a99ec34a43bf4faa039de454d3d38d0a5a4f66d1 Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Mon, 22 Aug 2022 15:22:34 -0400 Subject: [PATCH 47/93] v1.1rc4 announcement (#1657) Adds announcement regarding the release of v1.1rc4 as well as the expected final release of v1.1 on September 30. --- _config.yml | 6 +++++- _format/1.1/index.md | 6 ++++++ index.md | 15 ++++++++++++--- 3 files changed, 23 insertions(+), 4 deletions(-) diff --git a/_config.yml b/_config.yml index 733972291..3ece1ccec 100644 --- a/_config.yml +++ b/_config.yml @@ -89,7 +89,11 @@ defaults: latest_version: 1.0 excerpt_separator: "" -announcement: "" +announcement: | + **[JSON:API v1.1 RC4](/format/1.1/) has been published! 🎉** + + Please review and try out this upcoming version of the spec before its planned + release date of **September 30, 2022**. navigation: - title: JSON API diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 236dbc9fe..63e6a270f 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -3,6 +3,12 @@ version: 1.1 status: rc --- +> **ATTENTION:** As of August 22, 2022, this release candidate is considered +> feature complete. It will be released as the next official version of the +> JSON:API specification on **September 30, 2022** unless any significant +> changes are required. Please review and try out this release candidate prior +> to its finalization. + ## Introduction JSON:API is a specification for how a client should request that resources be diff --git a/index.md b/index.md index 4f8e06985..3163e4545 100644 --- a/index.md +++ b/index.md @@ -117,7 +117,7 @@ specification](/format). ## Extensions The JSON:API community has created a collection of extensions that APIs can use -to provide clients with information or functionality beyond that described in the +to provide clients with information or functionality beyond that described in the base JSON:API specification. These extensions are called profiles. You can [browse existing profiles](/extensions/#existing-profiles) or @@ -125,11 +125,20 @@ You can [browse existing profiles](/extensions/#existing-profiles) or ## Update history +- 2022-09-30: Expected final release of 1.1. +- 2022-08-22: 1.1 Release candidate 4 released. + - Formalized the definition of specification and implementation + [semantics](https://jsonapi.org/format/1.1/#semantics). + - Refined the definitions of + [extensions](https://jsonapi.org/format/1.1/#extensions) and + [profiles](https://jsonapi.org/format/1.1/#profiles). + - Clarified details regarding expected and allowed responses, query + parameters, and more. - 2020-10-01: 1.1 Release candidate 3 released. - Refined links objects. The link object `params` member was removed to better align with other JSON link serializations. The `anchor` target attribute was also removed. It may be restored in a future minor release. -- 2020-08-20: 1.1 Release candidate 2 released. +- 2020-08-20: 1.1 Release candidate 2 released. - [Extensions](https://jsonapi.org/format/1.1/#extensions) were added and the scope of [profiles](https://jsonapi.org/format/1.1/#profiles) were reduced since their introduction in RC1. @@ -144,7 +153,7 @@ You can [browse existing profiles](/extensions/#existing-profiles) or client can create a relationship to a resource yet-to-be created by the same request. - 2018-12-01: 1.1 Release candidate 1 released. - - New features include: [profiles](https://jsonapi.org/format/1.1/#profiles), ["@-Members"](https://jsonapi.org/format/1.1/#document-member-names-at-members), and [error object `type` links](https://jsonapi.org/format/1.1/#error-objects). + - New features include: [profiles](https://jsonapi.org/format/1.1/#profiles), ["@-Members"](https://jsonapi.org/format/1.1/#document-member-names-at-members), and [error object `type` links](https://jsonapi.org/format/1.1/#error-objects). - There are editorial clarifications around: [query parameters](https://jsonapi.org/format/1.1/#query-parameters) (their parsing/serialization, and reserved parameter names), the appropriate status code for [specific](https://github.com/json-api/json-api/pull/1036) [responses](https://github.com/json-api/json-api/pull/1029), and the [presence of the `included` key](https://github.com/json-api/json-api/pull/1236) even when its value is an empty array. - JSON:API switched to [recommending camelCased names](https://jsonapi.org/recommendations/#naming). - 2015-05-29: 1.0 final released. From abd20f1dda016b829cf87a9350359dc92b4114be Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Mon, 22 Aug 2022 15:31:38 -0400 Subject: [PATCH 48/93] Add @jelhan as active editor --- about/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/about/index.md b/about/index.md index 3c5df3fff..02d84cd94 100644 --- a/about/index.md +++ b/about/index.md @@ -14,11 +14,12 @@ JSON:API is: ## Editors -There are three active editors of this specification: +There are four active editors of this specification: - [Yehuda Katz](http://twitter.com/wycats) - [Dan Gebhardt](http://twitter.com/dgeb) - [Gabe Sullice](http://twitter.com/gabesullice) +- [Jeldrik Hanschke](https://twitter.com/jelhan1) The following emeritus editors are no longer active: From fb59ff07cbf37564c1751a64cdc4714431720e67 Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Mon, 22 Aug 2022 15:33:35 -0400 Subject: [PATCH 49/93] Update http links -> https --- about/index.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/about/index.md b/about/index.md index 02d84cd94..5d667d5f3 100644 --- a/about/index.md +++ b/about/index.md @@ -7,25 +7,25 @@ title: About JSON:API is: - * [@jsonapi](http://twitter.com/jsonapi) on -[Twitter](http://twitter.com) + * [@jsonapi](https://twitter.com/jsonapi) on +[Twitter](https://twitter.com) * _#jsonapi_ channel on [Freenode IRC](http://freenode.net) - * [jsonapi discussion forum](http://discuss.jsonapi.org) + * [jsonapi discussion forum](https://discuss.jsonapi.org) ## Editors There are four active editors of this specification: -- [Yehuda Katz](http://twitter.com/wycats) -- [Dan Gebhardt](http://twitter.com/dgeb) -- [Gabe Sullice](http://twitter.com/gabesullice) +- [Yehuda Katz](https://twitter.com/wycats) +- [Dan Gebhardt](https://twitter.com/dgeb) +- [Gabe Sullice](https://twitter.com/gabesullice) - [Jeldrik Hanschke](https://twitter.com/jelhan1) The following emeritus editors are no longer active: -- [Tyler Kellen](http://twitter.com/tkellen) -- [Steve Klabnik](http://twitter.com/steveklabnik) -- [Ethan Resnick](http://twitter.com/ethanresnick) +- [Tyler Kellen](https://twitter.com/tkellen) +- [Steve Klabnik](https://twitter.com/steveklabnik) +- [Ethan Resnick](https://twitter.com/ethanresnick) ## Roadmap @@ -36,9 +36,9 @@ The following emeritus editors are no longer active: ## History -JSON:API was originally drafted by [Yehuda Katz](http://twitter.com/wycats) +JSON:API was originally drafted by [Yehuda Katz](https://twitter.com/wycats) in May 2013. This first draft was extracted from the JSON transport -implicitly defined by [Ember](http://emberjs.com/) Data's REST adapter. +implicitly defined by [Ember](https://emberjs.com/) Data's REST adapter. In general, Ember Data's goal is to eliminate the need for ad-hoc code per application to communicate with servers that communicate in a From 3965beda5e890344baa1ece5518ebc390298a651 Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Mon, 29 Aug 2022 07:48:06 -0400 Subject: [PATCH 50/93] Update sketch logo Created with sketch v92. --- design/jsonapi.sketch | Bin 32768 -> 7681 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/design/jsonapi.sketch b/design/jsonapi.sketch index a2d506b4a8e7048438dfec6b3efbe9046ec31068..22a25e8ef1a9ede9dd5655f6d0c3e40f79339bb0 100644 GIT binary patch literal 7681 zcmb7pbyQrNC1E_Dgc0s=vz5k zzH_v8^5C>{cXkR$g~w-e6GSdY>@}o^%}5^lcWHicY-8)NFCU~+O(%&Obe)tYJX*rU zhJjlBLQwhgZXSg*Q<_-V8sI*B&Qqj!213(*!80;#{=Xw~v0dcp^vRi6f7mh-{-J}i zr_)(TF~$wDTQG(e6jd6eIO`O4=mYZoENS7f^V>f46F}!b65f&%q-Lcr8ih_8zW`o0 z{tV}w;P2K`WUK-B5@Dwv^UE^!u!E4gv(#umS0JI@1U@`V9Y=a6xZTqzaM`zA{?>Bx z3u?e&t#}keUz*QR8TFH zGk)u}CXG{-2c_bALY;0PkyEegAKN-dE3|TH?*&tIwNwi`*kyTR=*c}&bAc-AKhVO= zOEu)lQ9I<~raC}!Z#nCl0+c~?2@je5EJ{-QRV0MO)Ua0)cM?B2d^OkmZuE26pJ&ON zC*@htN|@8S(`cYaDCVJx6M{}XXSsma0#C_7PfWv#rv2FF*u^uWNj}C$l?J-E{vdQA z$gRgWnz!3Peo{<}RHE>#ICXk0m?i}(J!FpoHq&j^G#|YhDxRTKtSlVwPkvx+xe$Ne zpFr8o^Cs|o2&0)sm4fGy*{!^yvwP9E^^ivWKgjy2VOb7gC=ZV`59F1AkRas04CX)|?gkemcpyp0lfjof z-W4+Goy_%4E?YP+Od0B8WG^a_#KV}=<-fh+l#d~@7J_B}sMWfGmXIp3dtU7y7B*7^ zC}JDT6xVCWym8>Cw%#l~-Q`OEaz-8=0&`jE&m%++vD7n{!r?jr_26^I*OJXut#_-u zw$|rnThdY1>{H?qd9_Yh4GJ8q8$LyOI+mp`n~v{=@bHE!Cd~S0KYN0s|lqJhI}e zl}k+OhUGCh!xdaX_iW5)q)2m8QIk{KeNT4b=($qEMce4GOj1PhuWW3CWohAsnWMqO zcZ^Fq29!me^Zh~1$W_r_^}0fq?eItW)Njr#x733CoDVclZ}Q%MOm+YA0Y1I{tHEJm zv6h)`z>I0J`O+l)w$XFlsWj(AA5R>FntteAa(Z~%S=$k=Hv4i4Gt9--nd?Udu7c{G zt=y8cez`S|sQimLITNCrkS!ty0%jcC;RdQ6cgtZ6u!AbS`Rer4S zYmxP1XOGBt!Nh5HYFqKKICz(EDH=4Cz}N_IP8p#sLtMre=GM&GC609JS>@T4cDI5w5Svp^ zy8JDr(Ii$NN6W0duOC(XL>k6yw*{aEH$!vL{l+_inz8?1Mu{R;k`cY@BMa?lmUtkv~Kc|54oO#uLKfn1XKWOSx0ZEV)%DchggM!N6cev*v?>#Y< z$IDyUNn=!Qwx;oepYQ1+ftu&KRTlK!j%z3_f)j)-zXrSx^A198lrlUw02ELY-)$8i)^z| z#;*c}=HAQ#%FuczCQ{b|1__J0x2Fm4`% zbA}V>SkcxaRXauM86p?T{J#=2+~_7$_I~3nc)owha;-d~f0kLY=`mIr(hZDlwK1$* zB<-M_Kw7o;XyQTM&)8|CK?${Kb=SXBxM?}{iw-|5v>ANXN$hD)>3RP<{9zJW^@dQ{ z=(qD@qmQ>$naW65L`FKRUpA{7d*TsZ+aCjuLd61;R$S6yy@@ujH7~RLI=xVOoP+lK z;%BIit;DRNc-SWO63stKhi`ORHaqGq^fwD_?rw9+Ns#+%sq-uNabMPsH2k6Volv{5 zBCb!|JWtQ~FkIkyc%ay+dSgkZ&*_;+DEHV~BTD=%FG1Pc1W$qdC5y7r)jO@nsieK2 zyOc5^Z|(;CzH{bT0b?OdTp@)OD2UF&dyp=2PnbF}h}om(dhk3!`N>TAiMx1Jf1uRy zp-Fl`NCnRHSS$@Bw9r2cUJDj!96A)0F71r)-vFhU4V+P}(X5@AT|A7TNu(EarnXaM zQi+8|hPglY@(=x)&W`l@w6iO1@Y||lRl=)q%ilFr!-DL;pGW40SA_&{afgk24)yvi z8odqJP+T5KlfPr=JOZb)Wu-8>s)L^uss$H-a>z}&yS^Pab-n4tV>E4lxH7y$kGMD&W$V2;5bhz z8Uc5td1A8`4?_RxtK{P-t?LjzY8*kB2zuvk?epM5GOpwe{j-&~t;{-llXM05CE8b(#>q-_L;hfY_-Lm!+xbPwH*mW&T2 z1%qF|%-eh8HY&I~BQW{ED|+5}G0dS{HtmpB@FAp|x&Lk`f*H!W zb%Xt%ils;BPmm*GGIivCDduSHVg6r=@v~Wx+d`-6^uu%C9^MV3I+amt z_VwsJVy5w-N^0qH=_9rmegcv{=!9}Cv+WoqQX5baV@7E0N^CH8uP|wS+-Af#d+XvM zCzZIDjG67haqEzf;zOXNAq$TRv$!d9ZrR9E^Y7t|Ug3a!k+no>UC&ZV2KYSNZ>OGB z<2K(6@5}BvD0M?9FMZAa&Y+iZRk}q-ps$J8QdraYkLEcY24#@Qc7q4C+vAK8@p(2- zv?OEK>@vIu=h z8aR_j2moXui1=>|<7Vyo*4oRR>%SYEE>3TdvIuPsVd|=KxL6ceh%vYd^3s}!dI&+1 z7>IobNKp1lAu1$yO*tt*)hKue(UG>+Q?OA{0k9$37yzWGw*W-c3_zR|fC51P07?N8 z00mJa{e4$}{O_+r1t|Y+Oa2|0YmXZN01%=mNJF)~kq&aa;?ny-13|MSL2NM{*lY#C z9Tu>dNDIv9XbMyZ7`f%7M6aI3dp!(K7zdFOi)Z(edd#f4`hLvpi%S!6k=4DLyRTQx z8Q_5>ngQ|p`ueu|daWzllNr;X2d)Q3yvY!h*r^a3`YgyXJ}}wgx$tK)L^Ty#4|7Vc zWJI}GlT5Dkbrt-jQkP~`U;>t})8QIrYE@`V#+i&oQE1%lo0AqA(oGKWb)_BB?SN!& zGtDXTs&nD7Yvgk49E^$I?cW`Jdpc}83cOy8l6bnWSIXezF!=gemCl^g2ztI}Y_T?1lB@T%|GPoZDD9ljR^fj65q?;|9*YTkSOeS@{=^M*5u z=XDow=Wh@9XJdloZEfchN?U}A$2Maj=^Tc335$M7#GK1Z9ey)@O0Ym` zV7$og=UlI)tc8svIcf!8G5pHf6@l4abTtLoN(hkp`ecBnquYtQfxo63tQT-G<*MY8 z#zyK$A)171L{MkVmxe_eGk^Nkx#NQL6^rp|mSf!z6PdBcuk{3p!1eb+-#@f361le{ z&g6HAir>veb;*69kHtgcj3WI zRTY9N+?@fl2>+_uehQ%l7nCcu6pH<|`0l26)B0~7E@s~FpaAhu&wk0#JkNioj^a3y z$-|R7SO3NtF)6sWb+4*zO4kqya)6M9HGAu9gl{Zv zhTozW!@P*GIjFp<^$YDZxkRA9Xd)cHIzoZA2RAY-R1$ZsyUTUGAG4dnwl~|kbB~_SnD6wUjRK(SRb!+r`}74^doGAieMG=a>ez_*X%?G*BQd<0cyW}gsuGYN!i9~ zJXvrbTQ#mTycTenQV+-L-GkIby8~*#iB{*)4Dr{;J@}3owj-RI zRP1S}5b49#JklX1HGdvw~3Rvw0seR?-Er*ij z=VV>1>7jOLufJckukH|}RvsT_ezmV&J9sQ43;6C%SUl!@4vlkPd^ht9IYegxJA61; zgOAginw;5@*mJ>kAoDww*MfP+Ytw*t3ww0Ud67fT6WX1_^U=*PvOmdeE^&a3f-pQ@ zdI((>2AZTMIT3njJ+ks1+YrBUk0|ufiWayiM zm@9lE_S(X+UfX?3P&K$dMR@lVhb1~svZ$%2eAJSvgQsIK~m!dFrK7?RO$ zI8M3(AZGk+G{8Y#6q7g1ffe2#%*GSFjgEW3h^Og6t~X{zoIfkD&Kfgtbt;9cgoGN^ z(`G~+C3yOVfZb-?I$wmlx(iv^iWo!SPOme>-4R2}0RwBIO&q<~C7W(th;2Ifwz9OH zlnR?#XrCUb2^%53@L}^hPJDGPtRO7W@u&1K>RS63L4=Q3Mr9_#XHDj?TZAA{ypk^V zti*L38tx?2AUgVv&BZ94z?u?9JJWQvf$ozj8U zYi{VXik2G=JQOO`UUL+Jc;z-w;){nk>%E#Dyq?nTxVpPYti zgVUj53~!~6Cebs;JU^S(ANVC?37)qjZc-Ze5uS5JO2Z7R zVF|V$M(A}i@kyMj#A?q$zyjpYqTx3omTIsY7>UhDW}%RhEP-qFDJhoKNsV@+JVRK* zBa@A%P)jNc**qLvzXKJ9&wndq}f4n;~HRI*o`GaH~CW_qhHtq;< zKmM*Zl{l(f;jX(4!xty-i3-|{`fR+bUDScwGHW_wlxdTdj}F5;9K&SJk!+~ zY!R&WG8K7!B9QoGpx)1tTLcKP%{U|aj_}Gwp5uelhSZq$7fXIegwyCBde&1L-)$i) zN1vr*{Gv04v2FlS(_@FaUS@HdBMW1Qmnvt4?r6sY!DTO0ISZco*Ll-!4=W4FFcZd| z=IgkKb~+b}dN<43fN6Q5EHOFehb`shm5mgVGD(5jHin|T8cA94Jn!j@7;#(|UOo|= zlgepDs5UNrzfS@S0l`yIv5Ucbo26u?qKSfYRN$oI1o8QvlcD2QjOwaykG^ryx!n&} z%Un-X8!>f#?fv%Ohepm=a6L1XK8$hIS==GQA-?YKWs;-vN3~o=fpB8!`xMvWp(=&w zf{oLX0*a)WzCe!q@4|UB#))$IQ*H!-Kj-B|84Vi~*^r&T)8qo*7;WAJh=xETQwGaN5B>G%|{f^3`NHVuj7D2kjY;XqF8`X#Ant&V!B}r$1isF<_pdi9xZXAg>bbHd408TdUa`mP^)Sx6N#hBREZZzey$yFwZ{9wx*RfWynD=eLH@^(C z?9o13h^NsQV5Pu?o7z zqYIZnWM~w6V*b!2re36|)0M0&^We$YxYQlW`9C474BO0gf-;OHv8x+VJbGO|uriOJ zVA-MpTA!9yz;ciqDUr&`4{|^7GG`J;zUnB!yw)MaGp!)GVtXcFTYa?F}a6!O&WlRWDBc zUcdycQHfKLnRAhi2V*7@!@i-{WSfzOm}!EnCCCOG@~>0d2NN^vPU=TRu&YrCot6(G!9+6rt!4kBN%iIKENZA2yuGOJ`#e%he%*^k{smjGW=`3in-QFp@n` zyA!W}V*@U8aWvxi@WV;S?p+Mn)NDvCu={U0-3|p`aAAuYeIj4yf-JngciQNW65jZv z2cxldyk3h9W;DQrw(o2>6{?1Y@V+|Zwm1Yr!PlAdp%tj{Ew*k_7KDn?XS!s#8^JRX z?r)#YxXuGYu_9DXDUf0gBsd7 zw{|V@z9Ne-1tvvx&E;D1T&Jd%!^myP_1#gt)y;Tg+KZ%I*dg9?tZR@;q-N@-6*TlA z^Fy4ssamSSGEHET?{M(NtTx zl^W|Q$FUjmP*)sC1jRb_owZgt)In}L`A0TeFWfrl`q-q*w_K&)8p( zV~FDcrPl3}9MX%^I(y&AFo&%7MHpbkYY=$9!p+Z3C9=okOqhnvSscw;P;5l`B*p$X z*)ghMVc3rnGTBD6po%;$PP31u$gJn;ybg`2S>__k<^cNr zN^I`N+T3!DJ+`m}-Euk}E~O-geuk zRi3u{tJrUj^|9dbqB0Xc8CX^#M_}5ghBggyYU0LPX*ggHS5f|6{=TR|zJ?8lh>_ai zQt%JH@-*{f_K@>vO7Rn->_CzEFbX9vS3{kFZ$w1W9d9BOHnPUy@b?Vnlbxx(X4`8+>l zMoYK{Q>mDbVgI6VSvq-e)eQIo3e@!LzFI>T+U(%3`_^YFmn60pL~0ICN0TuoBp`Hv z53iJr#4V`ihS6GfNkg!j$buMf2>>X;J;lI9eU9z!Yr;_B4ZTm9=V1#l>y6xzIFG z*Qe*i;x<}?5R literal 32768 zcmeHQ34Bvk)<5?qX{rH{b6C(%g67z2~0$ zzvrC)dGEfo-q|xk@nCjyB--waXXisU5CUb{*#Mx#w;bPz7sW#AF-e^GC!b1i{Ph$q zHlV}XVfelHLwZRFNC-#>NC-#>NC-#>NC-#>NC-#>NC-#>NC-#>NC-#>NC-#>NC-#> zNC-#>NC-#>NC-#>NC-#>{HG&OMbj)G)MKHC^pZ!6>X+m0shm=Qp3Rh|-Ts9J^{2IrqBa)zu2QrN`9N6$%Ibx59eV6IOfW za$`@fue0-4h5gC|?fyvn_@+o}upQy?M*;}K_*h#o?r+UseYOmBoY)-ch{sMY7ANVB zMt$8UPBKK+4MO!AMAG1H4@N_NUq>xMzch+pppULzT|?!z9#c5j(GqVx`49-+{}9uj z%n_>t1m%_Cl-fi8@=}j(E-ZHD1$@n}fUl&mpr|-MnD5JLD#_3D`|}HYu3&R8(CqgI zT&wy0e=;Nk@W1qu5Red%5Red%5Red%5Red%5Red%5Red%5Red%5Red%5Red%5Red% z5Red%5Red%5Ree~e}%x~!-yiYXH`+VFVxZ084ktbPUit2KtYDT`da~M^e{crkUOw* z+>jd)c9&!Ga(z*MYY3}rbK{Xt1CZ5QcCsrW9T>=hQ(z2?gFGmPiEsu?0yk8`bf|$@ zP!IEA5i~*zoCEC;fu(RBtbhyP5?BjY!ftpLUVxWiKOBJ9;9d9#K8A1LC-|A96FbQ! zIph>Fnw&<8NHHlPXOT&yicBW6$z0Mv&L+zVM^=)H$i-w0Sx2rW*O2vOGr5E8B)iC+ z@qeEym9Ys&2E?PyW(;7O9dTAY9 zL>JRW>Zi?g8SSPkC`T`%7t@V&6YZt_bQisw-b){%57Wo!9=ex4N%z;~c65cqNATCF zt3VAJ&_V|2fCW7mzz8PD1T$E`if?2|18EuO;dWgiyg)y+0C; zL{SZ0s2$a+h=jxVyaA41FC53XbWX-8IW4E#52H}TsW7_1$M3T@1|poCOWTKaV>!is zI1L;y9wy8er^SEoy+JGnV~cCN)m_4O-Gv?ct=P^9uDJsn_6>tHQDimQzx5TD}=aA&LU2#4JTzjVN#uNE_zX7Fkw>3v9>`JVi1QeSi;Ze zS6ZR2NsR{g|F_Lz8FX_tE=!!na-4c@ENKR)vTnH;+6$je5M3Q*gtMvNpI1*1^?q z4g3MFh3jBFY=Dih2|H|t>){5t5w^fh&k$8={f8j}NVN%~1@G7;;;Eu?h_PZMCh@NLNcMc5Y4fnbQ>xMm_j@K^6s=gT&^AV)da|2t9bELK<8VWRoVlyKCwqRgk%pXO{ zm?^-(cZzhy8(CAVHPRIhl;hKFZPmV5TSY5IjKwh_l8A0R)x!b9jm}AAU)(7Sw~QN} zQ^txl9LM!=D;S15l^d(%fLp?FzvFwrL3kYYz!SKTd*MlV3K!{V=&y@~&I|Ii8|v_f zyATn1h3;ze}*^UO*jgFfw$1Kj=|gT&g^c)(2uJf zk0Nlhq7i;Te)a2?h63@{`qp5mr8Pc#*>U(rF*#+?#{}$-7ZTu#eD)r^UtjH=gY4c1 zAHaw3H*gIc&qX!)`oY@O^T|uL>kz8=33|t;@ELp#Um)N+;46F^(OP41Uo`Fs`Xf=n zu6aA0k59V=qccMIF)yA-UC`u$9f83OxiK8DDh{(l9@}r>JEVDmVEW*D_yK+tcweY! z;DZwHK!f!Y7w_-5P~*6?1E3}Nmv0D#u|!T3BrPQ*xKhf_lyV-1iZi*>IR8;rj{)Es z3=)69;BXUMMHr&QX|KcJumOX`CJYz7&`;DvL$tU?7zT(QkBwOFM?m_Cg;)W@fv(Bt zZ)-tc?g$`%N1~Vxpo^Ceu4Im{nu9B5cs&%$Bx4YXaVfLq17qGH;t+!1jbuETK%B%y@^CH% zq_8fAAp%1ZyF_$%FMr6dXTA8Bh0rlCWU?=0MsNjOAub%{^1YoMEsbn$p);?%swl6@ zk>{y$ISPskT#k~`sys(gMNx&Pyr8h8ys}VOV^T^cE=>4?7ag{boKDUlXJYb|TDvIe zGklxDOOC_k7v@z}8>O7bcS9R(G6g${RNX|bcYz*$gSSXzmy6b`#7r;w>+8ktUJkZMvxW|CQ6%!cZG;m%fH zZ4*9ITh|f|20OTkIg>sUgup*3h%n3{UNm*VKKe*4sU!7*sS6dnsSAZ)%)8X%tn?I= z6gpf^rxRh$uX2=D<~bcDB?YCfDrZ%BX=S-6e;%2SfC`rrLKxge7LbKx5m`(c1*ngo z;h{c$gh~nRc^!npU>%OKW^@eS0H>}aO|YK$Nq_{=MR-#cS(WG1KDdQ6^9)HsRS?ubVcXJ;uv3A zf{XZYlB{iHZ2{y~Z+C|u$+IIA3(gJ2TfM?H5YMbagq+ILD^JCZ>JbH zw zQqnDZ&;`p*aLd(LSDvhU714SVF?(GI{YT*~vX)#%E=NqRBv)~xa>^=2OX55^Wlph( z*4i{+UXN9Y1@r}1aY8@YvS zCp$<#xs}{TZchm_d3ZTDzAe~2K3PZ&zpljD)Hs}<(%qS8kk8HJYPdRXIyZxx%6YkI z+?@Iv@AP1_BWKcAA_8~;Dfr4OR4_Lxg ziyra-c`(tpmpp(pSmUiiTRK1fBvN|GzLQE9`hbVL(#v1tiV_ZzLkp_C z$;`fwyh;ue%wJL~7h(uVwip}+4wBc&pUE5KO;r0R`3rdq>Gl{RBtFuQo`;Gj42Vw` zaV3(+F`S?$7!J1h;z6!~Tg=Tz{yiJBc=8T;m%PU>eN#7Yck`wstX9`4oxo^AwXxwLd4f5NUA15%MMZ3LAe-z9HX|@5uM$hXJF$ z9SwRrnlzeriio5wCkv@U|8=9Dg9bevO&U%62vyKD(9(3uP$gASHPxi3(oc=3%=X_{ zm8sk!RA%~sA5jbMM>E+|o#Ts~#U%y#uKeQs>|Z?q-m7p0shwtVja72Y!enAnM~Bj3 zi;mxN!AqH~ST$VmH~zv#SX(-Rj>JZywFz;)kLJ)^dJ4D(S7X3W%1T;PAYpcf6f;X! z<|1Y0RXR)Z92G84v7^A_#>spg_zaTR@mp0IO zsNn*-kSDW&zpKxi~THgO%uVzh;}qL+o}Ikb(2X*=zp5rM^chwrCd zbjfezWt{?x@eV(gJC}=a({m<$lJ)VMo&NWdbVJV*=_aRax(E=@DhX#iUv$P%qW_iV z<+%zI&gjg~FDNJ$JrhqLV(5zpFh0LY-oUx`kTklI9OGh~pNl8MEd4zJNN9ZMV z4K}}&uBDgJ%jp&L$^mG$(=Kv50)qhkCILu0>U zR^ZiyGY=Eq^89j7k+Zz2xcC6wOs}Vyl;Cw}KixuaS{!f1n<$g-PJ;>j*s1$Cg z2O9W$6+DGAtchDHdiqw{$EU}k_ResS@3M{FOt;Zn=ytk8OplXig!DLhG{4$g?u!Xs z7ND0W%7fYQ6?!YZ4Z*yf-a&WPHevhvmab4B7&HDXy#8@I*Uc>#{pe2gqw|t}Br10w zy&oe@@>WeBeSkhl|0sl?WF;Sdk_Ur_pTE2)zv#5={NjQY2~8fMf1*1Rqi1pFCr00m zqhF959g%nEIbH5zPl==4?JjZ@lvm|DN~%inD#Pt^d0ZtGg~dfBqLNS1r}4%Ce|Mmt zK0}|S&(Y`U3-m?$5`CFs9x`x_zp22tL9m5DIT3R$|0 zm5q`)WD{i-vbnOeWpUXhvg>49WWBOJ*$&yQvU_At%l66Mk^LZNDn1()!XKO?x5jP}GPTSi<{ai+=3?eL zW&^X4+05L`+`?>U`kC99dzt&02bqVMhnYv1N15HsYL!8ir5dRkt13}VQZ=YLRNbnTs_Rr6RGU=St8P?nSM5?g zsM@W1R&`kQmg<=59o08#s?Jc`)kD<7)YX3T5`bzax>W%8n>KoKIs<)_n)qU!l z)wig(t9PjT)wikdQ14Pdqkc~Pg8C)(KJ|X}>*_buN7Zku-&KFA{#^Z~`X>#eQE4=q zQ#9i=XK5-mHJVwPIhtBcy{194P_t6ARu)H z->ZL0|FZs={(b$A2Dw3LFc^jzPBr8k$_zCIzaeZm-*BnnTElw7M#E;q4Tdd-9frFM z_ZS{AJZU&=IBIy`@U@W`wMLy$Z!{W9j2>gPvEJBZY%?x3t~9PSUT(b7xXyTu@mk}0 z<3{6V;|<0=#+QtTjc*x0HhyEGrVNwCWHV)%hMI<(MwoI;rJ64?=pvHj?OH|tjwI9xi~YNxjb`a=Gx4SnO|pqoB3Vl z4`!KJVNNqMW|diO)|fNQtXXe1m`&zPv&C#R+steVE3wL~3TwKR zwHmC$tsd(v>pW|dwZpp9y3%@ub-i_?b+h#b>lSOTwa>cEy4~7u-Dmx)^>gcwHn~k< zOSdU)2HSAkX|__^WZN9uVq4hOZ9Cs~k?nHZm9}-ZO}6W8H`@Aa+iW{+580luy=;5K z_BY!%c9~sc&#<$0n?1`u)IQRlYoBhfwJ)%D+Lzidu&=dmv~RcHZ-3POwEd9%sQnZB rw^?af)~r!kuB@W0)5S!J@_+IiU-Zx7XX0npnTeA0DIxG5jlh2atq~8e From 62183d077e6ccc91089897c89adb9d5e3d6d151c Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Mon, 29 Aug 2022 07:48:53 -0400 Subject: [PATCH 51/93] Add jsonapi.svg Exported from jsonapi.sketch --- design/jsonapi.svg | 1 + 1 file changed, 1 insertion(+) create mode 100644 design/jsonapi.svg diff --git a/design/jsonapi.svg b/design/jsonapi.svg new file mode 100644 index 000000000..46b672e95 --- /dev/null +++ b/design/jsonapi.svg @@ -0,0 +1 @@ +{} \ No newline at end of file From 56fabac64ef7c51678f51e6869952ff2c067e589 Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Mon, 29 Aug 2022 12:06:55 -0400 Subject: [PATCH 52/93] Convert fonts in logo to outlines --- design/jsonapi.sketch | Bin 7681 -> 24378 bytes design/jsonapi.svg | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/design/jsonapi.sketch b/design/jsonapi.sketch index 22a25e8ef1a9ede9dd5655f6d0c3e40f79339bb0..68d3aedfac13d5c26ab04c05d34c23640ef82b0f 100644 GIT binary patch delta 23304 zcmV)jK%u{ZJi5LCupI&m*NL|qUq}D|*$V=bC;~NqeQR$V$&u|}S?IHi$VcSM-}>q6 z3ma?f82jbISkMwZ;#wmL6vwZ{{P%lKWp-B;S*>d3WP7cdo*}BmCYfCo85!?5@jq|= z>+Ofz&!6A?^3A8)Z|~mx;?28<|9bf2f8V`*`t=rXu8h*Fu#Me%wep>;_qL1swC~bN z>#dG|8y9@UAN}#+;lthS$AABH_jvns|M2n6FV!#J+<)HR|LyMG?;rm2{_d}z9v+|G z{PIt?A3oppKlyO~>C@f2|MT#8|Br`{Pq!al{_H>R9-r>tPJZ&6hqr&edpCOH_jliY z`f&SnH+t(o??2!F@dMs@di)-5e7ODl-Q#b6?ms{6{`Tqi<2&5W-#^{;xA*b(JN)C# z@9^0Frr+f6f1PjnxZLC2=lg%$fBbgy@bUB0>qdZd5_p*e9YU!qy6sjfq#}4E-Ssi zyZ`n*p4lpV(qHf2J-sjg{#*aqf5#PTzvYI39DLf}KD^5$d4KzPGkX8Hvbo=`7Va7bStla&2D3MUeX?abocSyZ*L#}eD`?Vi|_8AxZ`+v z^Gi(vJ>5P&J^P)%-hX_D8~cy%c`F+H`{Db?$vyRNkezlPZ^2CiN4&lJh~@Dc|D$f) zFa8aeAMktMJ&Iy8D!=i6AMQUM-Z_3=;iIGtjY)8F%df`7XI@S!}*{l|}YkKeq%efRL!^3Lbsn;#CW`1a4g zfB*RK{kQKAMEn-teZuK_`2J~fJHP$r*WZ2j{S%*g|9E%zC!C{SjehlqatOKll^=e*+!lWmyr|=U`Y6S9v^ObPm6V4Hx4IYUo%c67^m1K?8yiC!{=1Z%_d8=k zu={TB)ut0?x7{kn*oA$6+GrJ&T_<;y^H(`vBj?L={4)f-kFrnekUG2DsZPAxcWZ}l z&1UUZ`?yi~|0@^t|NZ&l<1cSN-Ct$>zoe|U8nW9D0v@v8hS9dEQUy<87BK}HHe zg-gkG<2^n;+Af%|?_?8wx885IUE0Ol>E*kizX07+K-G1f5{Tn|0Pg}BAh}cZLQxaC+xMW7L5PRdC3EFzd zJ*Aw|cb#^ZlCRqcUfetBjCH$Cl3FoFx9YUEPTYD8OM25rzN)Ky{fg!5XdS*aM=id8 z-1`3UUOq7GpAVmZ-rpY7ZT{tNAznY0km$P-3~c=%-;!DGK0ZBPDZdF0$0_=J_nW(q z-||q>EPH(TZeT#N-{H595Bc4lk}|K=O~2*2^^;q(1bw4F~QeWZ~t zG}1r(@QZUkM*rBY=uOIx5BHz%ehq=2g;e?W>F(p_p1yd0>r*}^`y&tN<9olqFGecw z`d>>=<8Z%!Are*Gi*<3;xlP#82ZKmdVbzIPWx{H|)y966YI>Zl=%4$lrN7_^8Fyn< zJguhPP4wf)*2O|w`)y2WZEd&lPIt1#Wwm#y^I^YVZPI!xt7{75s-n+vf$rXcC62Va z2VXvX9=`v71S&oKN55g~yZ5($xql!p=<ats7HM8f0Vsehc|{z z=zn{E)TmZzBgR;-j6@Nq$v;s-NKSjmUV+nZdVcEvFh92`-~ImKON(e7T+${uiJrf} zMR)>-8z|Ozd5^1&9{)>A8ye(J8d5v+P5T#vptzp zfD9IVlJ5zkbyVJowb9{LxCIk}*ykMLq7K+HY?d-6NIJR5t0^*~hDlMIQ}@@7B0+oX zV^H9K2GOEi?Dt@@1t8bLnep0*p&{c%N29&z7fEIV{jNw)f=9d0uQDr~RK=|x^INir>e ztVufI40?ZR?S|?`6f6!OR8(Y9YcrP^fkKTsS#eaO3kSy~G0Magp=SeBX1;9~jluR} zGnKV@jaO5|xukj~gMNXbpbAAMayzM}qC~8Z&MIY?JO=^Fu^B7<^ui)}&Lq7ZlEBPj zB|z$>)2qCmCg24%5GI9FYd56Hgh?cS^Sp*iP668zX=C`P7i7uoA_3=!tOI@F74N&w zD4APYU_6O-mM2PU@0;r2Vrm|@IBzh7iZK!#1f!>f^>Kkudi^K~(qBZSRF2O4GOuS8 zJ2BR>VKTdTLm3M{WF!uZ&Yzj}8x&5j@t~2G&QCJbGT;a}HPK2ew~mwVE$Hok91Jb( z>gX~tV6D&R2RAH|oWkc?7z{8tn=0d=jnRW`pQVZlTEi4@kh@UD_;FewOMvDUYYvNP z_l0F%uaKc}T!aM=S)zUL_T=L2=mK3Yu)Iw+Gfa_X3gR9g1SWtT8F98{$xJB<9R>=| zdl3K%3qV3a7D7s5OqUtU}uLU9e_5aAzk%5Wr`W^W6WFkz zd&Se`mBc~Q7zOcY6I4gjjT^X`Msp}uH{&L-UUDSGFPKv)LCgvG9yT9;&VRrWPo4OFQTA%p;!`5NQABnl_Z&48g7jlOb9JaDKhLW?mgzH600~PoGNHG>!CZB zWL|=Q4%-ViXlXv_?3&?!@8Lecs)yjPP@HuXiDSEjrBA#+4V4h#{ZJe#othfmDNI6m z*;$=R*l6q$kIXJI3M9fHn)Bb!32B^rgBK>r5YH6+-1}5Rl97LH$lAUxq;c-r4M{Qx zE}m8iIeL!UNHB(yv*3M^MUv#mYB@YA(-r4F!F9!voiy0a_ z=SobB0Vc0_?{Efx7bAKltdUJc@O(}UL})%|gf^rW8|t=ulF7ln#rnF7IaR(f-nlH90CbyDu&2shAfYSPGe z$>wVtw;R9T>Q3*)bP~6wW4y9+8=L~B`_^H5tz5cRE`3dvOE5$tSr_^tz;3WFE$bIG z7mRVh^?_j;HUFmCvQAK+4vNS?Yt#K}Zdt>shMx3)mbE4-7E1=7IQm*vqhhUxZK0!M zk~!td7)LYd_~k1tYoXBxdsV}p6BDx)=d>Mt#n9NYwy@ksUrUBn@BM=UqpwtJSYyM- zU!iFfVRoOu0^=_@k4u*IEYCp6jK7?;+ioo~{<2L^z|2uqOI3(31%hgIx>eh#5!^iE z;FQ3B3$;2|Y#4!oJNhzN7{vT@P5DU5+o2? z+xBpeV(hkXoUH8p#wqiaw_9F)q{VJaoo<4E8MSf9P4uOmJ>0NHCiilvv0J3<#o8@* zZfn^*PM0;zxHKVc$w+qr8ZiX@rT!?Di9O34>1I5l<1O6SJT^8T36Dfmo^>_C?tB6LuZS& zu)uwO^=-?iH2hI976yMLeo3!F4Ag+Z5e)g&Ejqn(i)gQ-Vyvrwb*e5^JiqjRffo5S znZ^glhUhHRQh!2xDX~lJie$+QUX5R*2x~1>@=BaeA#bEHW^#0FC6644;aI+q%P_z< zlmFUENvJ(#VP-_jeayPhdc|^dQ(k4MSY~#S5tH?=by2YS`x~Db9PXxq1PtxPc?L1r zC!unbD`Gn+8p`V;kFf44@##H(Sh!S&&n{9?K4sX4Bu3j@402-W3)>ggOih|)^MW-o zhUGp^nOH)H6Y*>tT3j=?*N`ASTCZJXxj4*>l!N@x9m?nk&BxcURF@j2W~j+$odp-* za;5uM=PJ#uGuLjJDuA>AsTEs=wN8iR#Mqb+zuZ^qG#m*>r~;N0_lqQd&pJ%!g6`|E z>rM^Cga`~y7RhU+^MPc=6coJ;$??@SwaUfdB(h-=lr~`TQs6!jU5k}k6Cnb9kWMaA zkzj$~jLJq(J?T_BZC@_kFvZ5)P+;4az$Py3PV5PD>^WffF@7AD6HH_X%>)x}TkFhd z5ZD?%C@ep|R-#-`Q$go{1$t}nM>31ZM2j`0houD-O;l_fhKrK(s{=7;XDq1R*)_(F zEMBFK9`j32gj`Zh<*G=4g-wV7O+l4a8|-kFvax`=e_c{Emcf$28ORoc90C&gb*^sh z9947f4Yq8BgH_sB%0d)Gom)X+xf*s!l~=ul>Ht=*@bdq>4xRb;CJPMRZvX9OOCDdP&3`;@>h`S5%MtC z`%jfgodJ^Gi=fWZP4Nqc~9<#w^$6(O3_f-6~#d+-7yhi;8J~tQ6pjv@Oib)MNjYNp!>* z8dxw2GDEl@F99=CjHA}lws%WG#K9S1E1y{SmIc=ezK~azwfB5=OA4Q&K#bQVMZ?CR zf}o~GM_lUInUc+f$UYBmp{b-mZw(d@U)y%Q;Lrp}jr?4$IJ99J7>i4`@`+W_#F{d- zM44TCVyCEowh`}9Vh$f|5&QcD8WQ>BDwHwlZ#3^TpXyy$|@^V~fBr5s3WFA7e zjw5=$+;vjH5tgQZtxWo8cnRYBL^zfxxL^e26r9$>Yg>BcxQKz_!)Ea8E{QUPZb_+s z^@{{?ut%6Oj<5}l&$S1{HG_rVW9(mDWiK3oIFHFu)6>Jp5`Zg#xTaFl+JG~O^Ah2d zGM7+)y2Hm7x?8l3VBBk>ol2z95lX|_AZ7VlCn7n~1qX#S9`M zALDuu83I#|4Rqs|5UP6LgC`8uKHL$1a*+yrs$5S}$a3oT8amxWLXd(Wx4IKSgwT4* z_OEs+bbZVh^_tX{eZ&dGz7jeIuR+zxkN{hM*LfYpTK0P9Kyr`5H*z4F3e`B#G?GKZ z-t_J>Ez16N$=aG-WNL#OU)KpSzw{8u=c`L?!w^$BVslI>yC203NlQ{>nx_icb9Z5s zZPm5K1#TM6&%GhePeQeAfkcnR9bkBTK+33NtfV(1)w!f;4q^`~rB{@>+IE^uuLSUa znT|wqftw%7Gwk5qd$?~RH$tMhDve-fg54J5>r^=4CdpyyN zK0nzCWY%kMq}$+LJF#2Utsbp33LEp2hmAR{r`2TvVb&q;cWSlkR!PWzgvoU4 z{chX2O-viL^DDgyS3sDnO8%MvVc?TR>)8B}oHJI=0E7`wOgIbQm^kYu)dRv9X9K6Y z^!Gs6@Wy~J!U|NKg!y$>X8QC=G9nl|Zk=iswVH0Sk}F#O8g&-KNWGF z=zJlD928-pN(jvK7|pROO>+kh`)nm94}}$-PGB`<01L$6XjcNlcn)mx!blZG zQ7I@lthV6|Mdd&p?C`!+Ad}w}ow;;*UUtVFpNXE(tbW>9(`M zAha}F6h*MtrP>>3k+s)i(W)q=kF7~6OW1q%`xVwIMkJS!N}etVm5OFT*jm3 zdm~xyUjvaDRw0G7mrmCERVQigwzK^nD$K$_h8yWW;@riDt{c#=gRoteh_b-W{0R>riU3j$7@2T-#!7FT7_Q957U5pWSkZ z$8x5Vh75Bo`1Lx}hj>^J0(!%vVpWH39O7XdCJkGa$0yBh(-)mUoBY5uPEK-6g;y|< zW%i<5om*?!zK7lJD|g{#hUH#6&%x>uEDzr&K#8S#2auincw!b9N#C{kBLFZxPO`IW z-37O0RmNt2*R6J|Jq%3B)lIZ3t*-!>Kl!4JcoX2K9~>Y9uZG{k>v0}NNSI6y_-EE< zY)#zAY9*asx!B2m6+8I-yH4V2wSpvBZj(}?;4wO zb+h6yXvNx34zz};ur%UteiaAfhO^2oy=1trm6ITU&%VWmHR;pAa%HG2?tmd}#VmpF ziE5|Gb`q$$*ib=VN+uHA3|JG^9TBZzHaIVyifoJFi<^JIX_O)iM8I?f_mc|4F# ztmO}lqbx95;Pk}4=~Eqm2|3{!zJOwVb&$orE@HJt$-Mx+6n}Fd8T(rjZk$up>->^{ z-GtwN&#`ej+LF{(Y|pSX-I@7PjfXnInN%A5g);{B3fZGJ>`Mxoogwf!&0@MP>A*p- zCP*}gu>cyY5x!D9JWUX|5~fY16m6d=Ria}C6Y86?*~R3ewW{s-V7ROf4sldOH}M5s zi4DE%8DMisoWTT@7eU9FMGV|l6=Sk&8RJ}k&^i%$?hRg;B%ya^AsU#=ei^wriy}d% z;OT<1%ays}I{A3++AS#ppTg^4@;~wnX97NW`00Ttf_71ll69fXD0V!~NeMzI2y^W@ z9V0={`MU7VR9_sLAp=7Y0;w9|!M6noX2_CITP6`q(Yri57~fKydIX z9vmW@Z+k3Rb!9gsLtTy&fizKfLK#dPh?%5V881pHpk{EX|1lW2}yg zlVg~7Am}1f`lStgc9GZ9Lnxh%Vr>k6L|f^XeYtc)dK`{^AlhcuY%rbJlgU^eC{x{j$Yel1@}_o7{g@uvRAQ0Awu#P;0V8{X*1Qn@R&E;v#CciBErLUYMyg=eq ztIRPhZ-uFo*uR-VCH&mPz0)~=6UU6R>G41DgSLAeIO&)*i*VyP-7F_^qIi~!S$GY^ zWsQqI#*tS%+i&&BMPBc94V>TWL~~;4mbpK8FOZ`K4h-DUT+K?RV5%#!fSH}e3-%HO zmFdk14M|N{gMyg{ZQ|f7IVQB~N+gT3MQ}S%K$nGKP+GP-vn(;0rW`VVVsyB`QNl}U z@cijnAPPenluQKsQn6MVj6y$__;S9nG;oAZ8X4q8ksiE2FkDP#Nzuo^$nO)SA@v9A~}ZV7s5f9xX6 zzTTX(2k&VTgjote4&G>g{ztKm38khD4l*n^YwGmHC>lqekm4%@%?kcvvbL>{hX}*@ z$R=<|WsKuQ{@5iB@qJ$e!*P}ad!>%r-ExN%)1AM!@Mh)c!sKw zwhU1rmY_HSCyyYmkGc+Aq@N+(oKr za^B(>rismyycAIy4Wz?T>~eMynMR>a?TCpp*KR3XkH(HwQfA~Df-lh`wK@^%$SsnD z$ft}y_1Jb99NQ{?=6(WP3I^G9CGhcV4rG!6!8JBENX7yzi$E3WF=Rh;27S z7hSN7`Q@P-45T^ssEO065-GM=A_0m8{NPFw1iMAFJUT8hB;8b$h{dOP-5U>zz-hVE zcan%rizb?ntVs>V!>~#2)Do{Z&<5sZ>NcB8FIR4uAqEY9Vj}Blh6#Pi<{XpV&Jp@< zX@n$PRv2__cTHBxEVmxVkx+b=lObYdHRDu*z(mc%D~6lHC%dL5yn#KXyytL4x(~U& zQ@}EW?uB%51X9;aDf78SEbU-+wR$4)x;Yj(tB&Bz8@w<{CW+;j1HjIr2r<6KnTk+Z zL~!QXEsxEAAjO$qDQ<(uraEn59J$4ir{%1x00)#KhKM4cA+lMY%P1%TIDKVfV4tWO zN&yP`_Jl!#ZOS3A_?Uq6fna(#^x19j#3}FZB4!}HFB8PLsG(2{p;TE=d~%W36NF}% zgHBg){f#^1@Lnw4kRVwQa#kodHywQV1ZM=ID?uuM#>LVD1{7IT9%Ae}#EUORNNh(; zRs5h5V|P;HVN0#Zv)oEsByy3+?xI8}F*vUwb4cLuJndMWAp}BSs>4x^Qb%bK_+Rdj z5}H}$^<4wgoS~drx*-GJAjAKZbTQW!erA95cIP zer7p;Qrb^IASPoj({c4(BV%!n#Z2Q!sR8A*5l72~fwptf1T&Mmu_;NjIRx&v_a`Ik zuNMfKeOV?zb(ubg6 zH^gOE?1iM~!%0R_AGUX#1Px1#MPmgT;SCpmvbu4BmaS|egJKwc<)WV6Wre)~p&Sg+ zEZWYfF_RF!UKR)nX5aWLRp(A7Sz~cY+4eJPO0M&e*Rp0A7-v*=2&Rnn-JUotV-wjo z?)T+zfdCJI$%Q;X;e2~o*$MvuZqb3Q_U zDdk%#Bzw^%I*mNUVroNd+ab+edBD~9{yZe##jV0257O6<7+aAH(U6;#0MRjXU2K*N z=?e@;bt#w5g-k*}jN%sTFg7?6R)e5Ti@CCAsj`wi#8KqnBA;t8qtrzn&b`5wBpC;h zU4g70xv}a6Ft~m}kn@(Pi20wl^hK$EF->NhD6gl+>=JFLF|%~jnSLYn5VDV*E9DNc zdZU()%M43TD)6nC%COYAYqylAheUg>o6OOE$7u_2V5#!7)@I3s^gUQ11Gg|wLKezU z5cw;)euNF0%irjDnuzZ;f9Zd&r}I3^MY; zRl(<*U8ISMnOV7^6%sgV%GpEou^#x$ zjMH}D*Og>K5vZ}RjcGklaVP+BQA&7lHh=LYbJfF)WFfnUJEUy3p4ucqreQDE*q&Is zsdF;l_xNS+L|Z>DTCQtp$bFH2r3^cJ+>OWNO>$mAl|raVQpv*&U)*vt4IA1oEK@Nl z4}P8v9Q90`K?uiFi?^KE6UV7do6AK@jkK^05_c2hQc;15&}+sA&=!Y@N%_3YA@U8^ zn%+cZli2w;*-(%8iDoUmyJC!i_$$trF-w&Nvk{c}RVu8Fa~E%ke>+rvI!0B7i*g{X zVaY)x^pAm8utb$(a~nf>rGH>lP7Y(k=t@A;XOdmYY@ujJC4Oy(2_D%#C_`W}d)5iE zFQCpi?ur1qxo<3EV&bc6P&dmTxcQ_0O_?DR;WjvP`Ke%G;TxTKu@6AH; zPTPHOy4%4=?nL6MTdmTnQ_k;pVzzr7w^w}dpFBRe+&DV{`Cd?e_<2H-HgKZi#U>Z} z{f?bHo!d+7Xw`OUyE0u`$Nfe}zgcN_#RI=8_^$~MoTHf?gK!*ko`OGPOcH)AavX$V z8Yb%ME^^m=ED}9##Z0fzCC~WU>>)~8sd8P6Ivf72J1pgGfmzmy(~R;}#mYH3;#fsR z1S-y?E_HOShs;uc`D(0hJr>CuxZCk?wf2m$NS4#$_2F7K_qqt8hB1%1jZq9IXwb61 zCUeFdq&X%r!osDL$~CpyUM-&4gp{wLEk@4FQCu8@^zy)~+SA*3?9o8HsQl@D`4Yqd z|MIvCI>V^Vvq%Nz!-#VTvU1_w)hAEl!qlU=^Iikz(ss&!(cI3=O4Tpom&~xptbA{? zyK|!X+%ZSVZS{JebQg5kb)vTGZnfRRRusMS+g04Fu)Df3S2t$Xjk(yM*WI3@Mx5=| z($8Ms?YgzG>rN@}b`rzRo9)$uxq2{H59VLjgHihD?ZLQLJ21|FEe;HRVp}*cPG8D{ zX^d(4bMs(-7Eut+aA6KiatRlv>GtZAXYo}ojQe?cFqL?;ukc{b7+f@8fwA_=twi}Q z__XcB$fjFqweN!6xUFK%r`=sEFn;fA0mM|NFb%Py`y&2?VUwT9wnQ$w+TUzw=(t1Sc}YbbnFU6PG-VdwT? zw>N3Cz6KwE1~b-A>gfxI8Q0!!Sg8%`aKGs!sno@-Ux5kPgyh58>diIGcvZ~T%FwRE_Y zAs)dg!lo-QftiO;J_}X?Y-8==qRKd!3IA(<(|XqYaM#`|F?xB{JO`L~aUz!U!?-5h9uJ3SWW|Pi-_QblgSR3ezS!q2Dgu68oa0%z;gEGsCn<*aOoAU5X_lvo4k84 zL0y>IPJ~^CQy0inC&bj19_^+rT&JiIV8@h81~6q~lTNW8RAPu)vc&xf`(MIBt7I-JOUZ!$*nzGPcniWFFi$U(1hHv-m%%< zg(VgN4aQ0&D^+lr^&Dr%K?Iak9>WGeG*(^t-EahtF7Ad^Jk$IwYnYjCU3t{&D1_?)5)l_BNIAayen!`mhEP|z2 zQP$wV3e#>&Jd%1S+{49`iJtJSl#hgX;zYDc9&zl-RL4uf$v)_qY&o@sxSd#kktz2R zYXXL{vo~|+Vpc^$|Ip zn73T2h?rYM69ZH%=OtMmO{x=rA}8+8jI1-?R?$FC_XB{Amkd@u7KuhJ0%Z>ZgqMQI zK5Qb+kqdQ4hWMi~951fSLsnyJq^&VxpizhmRW2DJfDq^$U}M=MAH#Ch%-kY_MJYIn zQi(P*zjTkws*`ZsD=f*jxTl78SSS~(q@>jkjtY&eW!O__D_9);#iZr7bLBEu!aoLG)s_D*{OAV8=tfvFqLbQ>-i=V5k{*Sj=f z!Xwt6Sh^)TjkC4~I_fVed-S8zZ`I7utQS5F4BZ(0;S$O$?H5s&DvTzWGhm9tB@YC# zQ=+s5>=~;z>h)NLr3Vjx%Y-rnoxt}JF8%&0 z17|xD-AG#)Ba1e?V#!jJ!zJZ|LtjShV77)zu(!eT^Bfk@-yq#|a*WCzdT88rGlZ}> zOLeAZ?FFbdjsn$lxddBVvxb8SrFOh{)3}C><5i3qE?F`kVhAOFOtCmAZEg{be_6Q3 ztby#Ei^@r9XWrn2NkU9W9lWAmTANho3RLxj>+PQW^I?S>>FpspD%p^W|z&Q~gK zhFTm7<_rP%j+Y!!R$5ZjaF2yZy{XPg;gmj3>?xOAt2bITF!0*cYm1!!XGfPZ4Svj+ zOO?wv`1O9=ak&(K?B=;eUY{NshYYAsPb}S#A`$-2=wfoIV;lzw(~_GqyGSHxKJ#%o zELMv%eC`cim?Tr9TxtmNY@VjClq2V^-LPUB2BMPTl0R`|f5O&VjE5x!`$CQvdvcA6 zG3RL<{xSZ<(rxRd$02la>C4!{rNsJZ=`a^@=5)!qis_ku4{!Q#vl{OtkhDHiNuB{5 ztuL+SSuan&5}bJsq*#dW>WdaL)YOM12Hu*kk! zhn4HLA@1WQZ9oxqtup(`SDA$yiSbxu7H?n>^=9KEEar_%*Lt*TJ=#}PkCq5som&8j2%dB2#Jh*T zdd0Lv7Bu03I58Ykk2(59{(o(cYlqQBhAmf!G;F<)PVV4la|{LpvDRdPv)W-S|mS@TuZ1!iT;>NWDpj>ZLs~hG}vxs zFM6}>;(opAB$;iu-ZJ#b)|1sLZR844{xb-Do~5xb+-qw+KGCPpxz#>_6}P%u1-cvNxB z1iZqza*A`Jn`hr*!&V6<5k-RGM8-qCrn130Zw>s!q@t2Ks&Ixa$Dla}KU}n_EFd^{ z?S^sEzKKYCPPo@1ZW%pJV(g0$MX_~%BLq`hiN_FFq=PQPKvHa7iN_vp>xC7a>|4u? zC*Jj(<=6`nv{{l_)9Ub~=JZ#H(lEVRyO^Xa8nAlpDr?a$wS>=j4 z&MIWYvOIxWig_~NX-E~0eTGcvdB#OB(m*p`SDzlEPf_7^Bqasb?1hgfn1>wc(zXvu zLSjhJvdI_EQ=sxZWyru{ejy4PG-NV6cG-IwUGArxUF7w>a*^pK0?G&P+0A!i>4pkm zPQ2m{MrYYAR$W^B77jtw4g%SKWeid_ni(Hi$!XcKni}fFnftpiMTkEkiQV|(927&1 zLJT7z3l104P$AB&-H;-O^8&pHnV%D7F-^p#TO60>jReTC3mTo9lMRB6ECW;M<1#_-sYP$L*O(P0i5t$ni@P#e7E$k8= z*`k%X)ZUyBm@J?H7SFerdP+o}ZONtyD53ity|$iRbCS^{lFH_4*$BG`sij)>`8C)Ddej9b zRHClWF73>bJ)qf|Dqb9YJbAW9L=CyrFY!ZSO)jh^6;OE)aWFl=*D2X8bL2Els{ zHU@-(5Ave1#l9H6PWPp+9`I4J)~6q#I3ykH2OGmwBG!ABHFGk&4!P+DM(o&43r!^f z9~w^_AYdE~BOjN4r%ez~MB^!;5J5EDR;rZ+;72x*N@V>3A-8mElrI&`$V5v8TmaH1 zjug9d%e6P-V_Qni3DlHL-s~{e_0lUd+42mc1U8(Atkk&F3e2QnARL?|?UqZepr+F*9$`W5tbHY~{l-0fUC%;ZIw9V{AKv5DwTl_7F3aQ*Uw) zu6EnlGf2W?T*SD`or$k?qeen7vQAXmxlt3bc)-oNs2imt3{Cj0M6z;PXT69$85_8I z5j_D%8V;p@KoL6re!gwcXk=&mI#0VV92;!M(p}4t_h2SVQ{^!{2(9Iq>uZCVMmv@o zpmZ{Z_-Qc^#m42ZHw>~qSp&z9K|EvY;#23|U`vuP#RTS43`Z65swaxU2U#SE>tSrb zACP$_gaQaPn81*MzAiv@?%EAW!iQ$p0i1=v0SyIz8(`vFE=m%Je4}uS7PR#$om`_r zkPO;J#}fLQS-PPLP7|Itg(8{}Yi|z0%%uWYJr2j@hy&iP&q)(@esIZpj5#eftAZv0&B0chn~rsjx~WW|K3gZm^|ke(84e-AY@aj+GUBtdKSaR!47KMh=Oi2y;0P{S zv2lodgOujbswqY%JzC~gq-V(OP3F*GEQED+##XtwuxPfG zz+;X=#&mj>*At~Uwk|JK9Yg&K$Lu2Gdf*ERB8P4{T0oH#5Wp1D(M}@Ar zBgNd2^wS=|CzA@PQ6rDn}FQrxvDlMdB z8PQ40`L^69eZ1yk+~D&0fa%O&Qso$>`C|{)peIMvF2U??8|uIjvYKGK`I>W5Q7Pg{ z!O0KYkwq6xOQhdgt_4G2d?vMjsvVLJW^f6Ha=zx1l!OzKoC?CiC~sO1Nsl;HhpUz4 z`V%|){g~^CE9*}JeCCkKRfpEy|C~8)f-2X%*`cqbvT*kt^q7_`PY>_d#JRib-t<`{(v(&+3nU7(+^^f$u{_*>C3`SmrCq^;V()Na7~T- z_;`T1lWSXw30F8Cul-?UeD1IV;Z8V62Z^W~aLQ8W&XH4IWP zEf|;a<(Xz+6Hk9NwgkkA)yAZ5qES~DFMx$J{9n*^RWTndjn2r@oF4~d5!P`RByGFh zDsDSTcGa!dvhTcK!8Wje>y2KgE0D!cAIL&zl8i$L5`0FluRF)>Y>3d-Fn zeb;GssffX9<+fA}-D({|2d(Wo{6o66wOhTy!CR@-6~p2hF}Pw_Trn(uCKwh@?Kbe| zR44lwp{zF=%6hl!U=H}LY@FS#SJ!y|Pe0xt2?{xkR^i8aspmXjGwv1oRd}1zkvsyw3DaBYr5jfiLh>bU5oJf#ZR|R?Q+6^hf zeqhDQ3MavpLFmzcslHFw80CXYeyOX5@z==YC+kpB%4Oi}3t|zJ^WH0n*1AG2ZxgFP zT?m%Jh#Zw;IgydWT{_nm@R-ohj)PE=WnEn^S5`rDK4!OI8g`2K(zw}oY#jrMWBJRlG((m)HY1)+0IT0Xl+P&P)ziF3xvXxXd84~Ixk1g z=#O1Y;p8F}apEI6I1?|Oy1%Az;shddW-_b%h_YjsT>T)!p>X5o)ZaL!cs7m$8;nRTu#$?j}t7A_QnPyQn%X)r(VRf{v1;G z08kwj3xL`4D#rE`;abAO7%kXgN?x7o^p{Ejj?_~uyz{X-14Ou_6bRh`Hd9{5#wj3< zFlLL2q`rwvm5#otGF%z~&Y`i)_F48TaGrW;Q&lW~&omq?%M#%_T^NnF%CY_3a2-=x zq}jo7(6()d$%%6uE}0;-gRw=i6T_S>5B+26m)K9wrJZwzZAsupOSE%iPA*c>fbV2v zA;eSn*L0pS^CCoVhq}?_Fi%hOlK4Ly9*6?Rw$wxCXyDL$PUcM5+qxriupCX0#B=IO zgEI?%G>JolyAEwr!hK%@L_gFRZ$3o5oDxkV~OD-B40cs^DF?#`PNOSeRJ5F1=z9VhMg+&oDL1;V?+ z^}&yfS;8?emK~0Lcd%HPrG+A(4@a&^VzjWb?0i=J>M4&juE{<684A89J|P{t_O%Hd zs1&LDmccF(3-Wr@42~u~xkg3X?>zfC62q@EUpOL+i3c+lvk&2lerz(qgLu zQJE5a2Z%8oavhh9$%)tm^W|m6o6B+c+6@tQoWrK}6Fc`+ z7(9>M->DK)4+kp+kG2$cvYripo=2A{BOjeurUDyu9C_2ho?N^k^y8q8d%&qs_QE^Q zf`1j+$)1+HF(`q)Cl&h!!&l{y8H`CYGPh$gm2jAeWvi^|kKzg(MPJxIiuFm`js)m{ zpa_Il*v2i(2uMh_Ua;|5m=38H5jYZfCa;7g*|ZZIiwF-7$|%?uIuTNTF5_5Fw`v*j z?8GV@ehxA~qe8?w)(O#2rn&5HE6w%^Gp{oqP1lATF~}$y(c5CO5vc~ z5Iko<1TcLKq3O#Ij{lj<&cfOg>&ox89Zb@FCuya-)qWSceR6nzRcfoY*I8KCa>B1_ z78Z=|1a^-7)iZ0kl=+8dN(u@^_gAZ8ZJy7yh8Jc$9DV`(3tn?{3rfn2zT8r?r-9LL z-C-4TKz~;<`tqg{{12AQ@%Bm)K_oQd@D*Ek^0W4E^ySlXV8wI1$M991=p+p0=&LPM z_Ut~vMjLg43ce6ebWsma4CLD|zh^7^tRXM8x`AKa}AZ?8UeGQT{YZ1(uqwQgVVFwbt(tkC^Z zMcy3C%!>aun>{DF=bD@U@T|pbzOz}I6}+@A?KZ1U_G;aK#i*s*?^YYT(qiGMedV3a z|MS!KeO`P>{t?>)|M>ag!}m{j-`xKrKM2gkyYf?b8h`or&5=g=UwG(m-oC&4u2`+5 z=T&?KP#iq4Fz#}=yA-FmySux)TPZFF2gS8$u_C2VT#CDw;!-%^kOPVr4)^xI@1J?| z=4ED+OtQ1FO?GFK>;;+6-;eBDB8a3lFR(o;o=XuN$ut5mUY~iK*XzF&h7nFGV`{He zFOj04K7+5xoP8%SE3nr}C|xmdK-}15;)K&RtZkt_X7h12DWKT%rAC8wXII3I#jPXY zuXy+C8+^UY4<~MFl-`2qs5h*i7#-JHhS&o)teQ4b-%BVQcW=h>oVT}cgwoBp=iK$Y zo?~hIdYp>fDVI**bMc`TF z8xkLnAX9s_5l8sXavlsH18=(4A_+W*;|s;cojq&L%KSC`S?h~;9XIuZ*tA(36!sA) zhcnxXuWML!vN$nmyb(lz4ABCb-_50J}>~hRFOJ6pi`{L*lK0Bf4zyXR_*Mvpm0l zeBuY^KmXhnHICvUL#II%NVe9b@XyWXrC@&V#DarompP7hYsq4Q-Vsi+c)@wD}ycJ-60*OKu|kBjzHtRk}qv z5{>s^>?;mo(X{`0!g?P1yTGzIv$5>h^I#jT1oY|R_FUDETstfFOS=!WcuCBxk{css zw%EwK>CnqCvizNDnkc7Ma&gyRix_8@6kDuKVPBfOA@lsXKp<-IMor>J%k`HvAwrkH zvB8DR6=IyLRgXFWpNp28on=UW$S-E66st4hA}a^542OjYrqKI?Med2H5KijZ><`{0 zJVyy2&$U6~-uT}gkZptS#Yy8VdC(+q6s;6hq&-5kLEYJfom|J|+Vb_|Xw!ymZ}6!% zDY(i3TQ1iUsE{M*(n9I0yWbQGnRXQmFvqr=5>g2?D$XG4SZW#aU`{hjE}`L`;opD9 zMS7^>xSff>JV90O36gAHbebEW@pIeJY)!h}#{ZU{*qZLIV<{0L>K~R@8E+h`N`ICw znqXrhhbJXfdI)tdeuL+d>rIZL$~5xhQQwc>Z`Rimn9GGhO+I&7)!aecJJY6RO;nWJ zr;9i&3>GJnH%v=FIkK*|Z9K$`l1^11@j^y?%tBMEvsq#3W3zly43frBZge^QI4eeQ zO}DiuXU4y7RKL)$F5f@XskF~{mwty#v@_ntD`E262Pa-N8m$GznhPLPcPzr5mcr$gTs@hO`*6pq1o0|CJLi`r~MUEB2ZC zjPx(^mV*x5Jskm&AN;ifNi{ddz2+C1RVil@olZSGVgu)aoUOU9&OLZ7Pd}4uB0EWq zB65_B=FqL>S2uNQ-`r^_VH_ssT6o!dKE3h;07E<00(b9Dz5A>Sy?^(eK|ysQ$Ku;p z<^Y&bwuPT8uM<8(K$-(obmRr@9oA~_xSy*?drrlM2Je4O5P|1s!D1ySw)P2>)3`T z1&rOut93shy;RVO(O55vH+tb8g+DmO-3+ei9oaKkxGdM1}4rd>G4lN+vNW)b+r z$}zGqt#@e8Qhor)h|M?JI_~aQNsJpz8~qj~W7CxF!Y_}D`H>ahAnB{K3CMJmS0m`e8|QUK92hs;QS|U5?IGp zvWFCYwcZ12#k)?Vs;v-VcXe4_9BNisfVlWx36e?1>dLzvQu9Gi9BWBPd}S1w>?1tb zN_BpZX78@h*AG#+F#WaJNzyxri@pP01uAdtOvm0SU88AG&=?gi=+zIA;olPS0cw{D ze}7*GSX^i%gnqIP503wp61p|Bn5WQ|5=skOcGuu{#xk>XmogA%KcNVrH6li~~FJhah|N*E3G>G$5@3KVZ!12ytD{ZiA_8?x!ssY&_- zuMeCdGGo!<8k-*@s>)H!v?)2kNc+{euyhv>>XOzu)uHxc%O); zA>-LpP%X#u_x^10Hu^r~GsQYs^5P-Cw5TkI=KNLk&wNlvj&BKI(1b32(hB)}lPaDG z&6AamPPar3T=x@K9J9uNC!Qe|;s zs{*@9kr7bf1&IGu!2yoUB!++hkW^EYGYm%jQxwv)vP3u0rn{zZ#u%BHEyd{MMxxFU zCLi!;teo zi+yv~6aF%XMRRM?hyK#1A>M6pKRbWJl8;)wH@h4ApH6x%`k(jGWmX!juxI%us154P z+c26<^(fe2x2rY-&*wct?#p2J+WPiQxE2_=R%zWAdO7YsZsarYdRMNLyhFJCepye2 zFSn6>I42HC=JjSt;-Yu2qjgDJf+pf-LE^l#qOtBAd+_>j4tQLdhop=N^i3L5*NOg* zz~r0HF9(G_FWMR~tQObf#mat);6ktVZ#DywdWfiw-!#Y8+dTY715TDN3!hFK2dsmk zs5S=j=-d|VnqC&(T~4Pf_4n%@yzlcll4UEu4E_@i2d~2kw+CPDvS{Rjg@F%H^ilMK zWD<=ZBxhy|yYmY8n?Sgqs^k<#kRd7p&Aa_f6=C;f)xuk@OejfFu?_ImNOh)Agv=79 zh8VR#(5?LS@55d?NT9dHd4}@WN}XA&alJVQX*7pYba%k1`#`NpBWV$o#Ga#OGxW3` z^$_*t@$j>WRlu(ybh_}(fYnFDYsxPPmOR9rf7&<9zq|TDKLE+>KkN(9f31Ou=?<}Y zTKpnCyOq3|S71^}b1drE3OyY}#+ST@_zO7`RI6f57fS>UMj=io)OR12gyB&NvfZz> z7Dp;K>`NPCvF5g#V?JZ?AdzTBUkv=S7I;$7b3&9AyZ)&}W)%x@pnMsdX5+Iu>w(DzuW z(*IukF)pF;bc|NV8iTM{B5klkx|Du5voL{VzIXr!aPQ^s^F=C^2&;_x10O+a(@!#+ z@J!JM_=L&gWIu0ycU!`v5f7f?ySKB6xcz0;>Kt)7M)pvpIGaH+Qy|3I78Zkst3Eb~ z9Nm-@QM!suB}4Q^8)90#WOFy);-sNn@OBnXf8eyCXE#U+-o?aXlX~-jRjZ(}7sb5m zIT_$~Zd$k2*)yE^iu}eY5;soQTHj1AcCIE6Fws*WrOz`?F=2^?-FXh9%6cNvbwtbqCrpF-gLf4RkR5vE`hgImb&?6NO!u<5WVO z=-`wLG5Iufg-trDK+z%E?XjIz>#)?9s;6DB0$xHbrK_OJY*Fc++M8l#6y%1^T`Ykb zHl&-Qg^GyhJIZ+7+lR}&7&#DQiKFgb@~WkOsWFo|0pDBa@$&P8R7+=QJE@^X`cSPY&UrlcD~SJ`T^+!(nPqo- zVv15aytA#G{{?ps>GsdYY5~0*oTUkZ5OnCryfScvSd;PV|5R4(o$1()>}f;u z{Bn*~T7jGDb8cOinb}iS^ezc%3FlI|AkJaFxTqox#UI9rN_A59bC}!?49`c_W=Jn= zNEVEVY{)k=m!=$H1Fyilz3+y+J2y)@=zo9b*@QbMQBEuLG;*bw+U#DT;ZeJ)@t#Y~ zwF!Pjcz6EskbYtcnW&rUFK1(Kc^Yk$meEZUM~*Cofb;a#?{fZr3ZNM%VL! zf05i4qU1jm;&Av7A9rH#pFHTPD+8|DzG^+JiAL_@G(M!1Ppm+IVo2gYcBD`?Gp|V> z4he9FC28lU2~>Bo3`*@hEL3(y)?R4X7{9%BTl^C2>z-k1421YiurSKn&=M@hQfn&? z=INc&q^0}8_UZ_&Q#JwCrDmMYZV(e8OQ)DmjD;R?-?qLPyqPEW9|EDCaLUFdBM4O@ z7xho8FelLVzm9MM$)SI93`XK`m*O?tehJ!BGB^}DOzZD6i>^Lc6AtyfTuu3O{U%i~ zmt#q6$U33?N(>V*YQgE?nqU{Up*bHp#x76!%H}?^^woMz! z03U(~o8Ky@rVI+%{uW-Q^64GQ<@@DPZd0ZCsT@<3`@MTP51F=jX#^`zCNrrCRx4TA za3N*3%vK`>1OP7jM#eYsnbBLLY)}(GKd(Ke z$Mou#kzhx5j9rrKFf4OKt=Q)T{2`W`-?Eq-yPiPjGZObT%uIxG8q^fppiKTNt+(?{ zb|bz~nVgDQFMUG^L;r^9lyM(<2E_;7FQjI4q#aY5SD?0LYh(_R;iMYG;a#N+Yx7mN zQs@sYcl#XomcQoy_C`0T4F=oA(}bNhmy-nbC_>N_4&aJ~vLd#Elt23SxlZg}Op&61 z6*C~pvftBVRE+J2SM&#h1vn>{N+3pl|7c0*>x%-AN8mKBODIOtV*Zt-HN{N1eBv$3 zBPvHmGHG7qKPx7TG#y<$^+z$Z)y9IbOrD_%q1?`P58bLX?$?)j=A(~c1ZHVl%j!p_ zG`ag_iR^AT6tgLBwa=Nx^CNFcb2j3VhJt|ix26TLV@(dQfUfNEuP6snc$37ON#gxR zO~I&iayhgxvdz^n)4X3M2N>Jo*E8d65l=Tm^(5#(EK5<@Gq+ED%I*mZsEwp zL6^u#GXGw#g`IVE2y(pa@Tie^B2r4d%w0K@Rli+cQ7L~1+m5&2UO!3{^V|1pu_h%t zvx<+Wj321=Bkz3I@HY64LybUc{O|88A_#wfM=4#3`5@KEJ{)8Hld2BE*;`-|Zn*`C zreY>ZIVWE|k^&X2&?dUbvu%#@pxAI}bNLLCC-iENoa{}R6W3^|9L}Ja?%m0{MLqZH`j&vxBHrF#8CDn8~cv` zJmdiyuV)0_p`;s{-N>7u4Fjf7=BF5@6(EpjObk?SsnCXuHc%2KJP_{Z{uwWzhz@i3rP?2ssmk1TLC=p{a z`Tm(7Y1*A>^pYftGXvksLx(J5&=Ks{&-FWQK;dU9iW?-457W)xApv3S!BRbm)vb)a zBUd+w+RqplMD&g*Q*om}N{+Y0iEllW2{@vl&_K}7!^1TisnZ;9>JF9CoKbeV05!!U*dTzbUkiZrO#X+1 zw7)zpdIez~uKe@0tvKo2a*<-W%d8$la6SP^Tt*Dl5lCkWOYGfBOcV46K{rf%$xf`r zZ@|{}(F4YLfN_=oM$}d9P9qKT7}V0f07}zMS6dJQa&2s^Qez3T@q@8%OMSkL4Tqri zVd(t;(E?vCBPj(dN&3v23vfd|-X;=Cb5ZJ;&NdkxJj}c{iCU*UB<8WJo{iOhIG3)g z>-rIOrN>7QRrSa$te40It#S0Iw2th-Bsb-_w=rj+@3U?<%Wx0Zcb=~N=4(ClMShSU zT|Z9)STQ+$0Gh{;H6o4fWh<3z$Y*UlFU07Q4f`OqqX;h06rq}?Qg`His|_sAfGBQM zJC2mAc&ad70qtT?udvz^r0}B{01TbLYJE-a#FgGi;zt|$(Sd$6jD)`Q(BIA6C3*Gn z6F${$%%Fw^4Ex7ZA^V?xQ`z*>5-;i=H&zffKi>#J*smfS?t0I=i$Y9)^>xQ$-Y|2_lLA-` z$Mj7|zsl`a=Lh8ybCI+rG@0qj67U-*hcybhcv>LQV&RXNh4#=dGwLd_?FdZRW8RfO zNwBcckT)!*IOL0Wg_RIfTt744b7f|}wRP}iBTPk!I5`hRf0mNT)PdsI+tl(t?0UcS?7sZ~eb_ z-aGG}^UZheH)rPl=FV^CoAaBdHVh=Jk^z&5V564T0v80T;{>I0VTuAqv!1hJ$iI%aYdB|TMcNoz$r1A(fjh|r5~^sY z%U3(ppW7J;@GR&fbh-gG!6(mFDJsAr!_@=FSTB6_xyLtm-_VFU84#N5KfZaFcI(AW z#miV8Y^ihPU3pxGa5JoX*kF6|sW5ggM*8rL1vRs_Cq`HpUv|)dlW1eb$G#ELEru>wgr7-`r@{k9-slUJm#xmJ95#HY)Dw^>cnP469{zM(>cD%fBiPi>(iUr ziPc}V&U5osoGiVT9P4o{kfQyF0k? z|M)_pqOs$kwBTk0e6|yWDL*$m)Aoi$j!Rt!Th#RZei zwER153*sc7KUqC=^NxBIN|o-Yxseb@OnN>m$Ap6w5*G>0Ev0afP{+m*aiK^S!k7*3 zAQQbC0JPe^7RE zq1T}zk4MC3DF68-z3CWX2yf$*azG$M!e})Yd%JOeH64Vh97YrVs8pN9aGq6Qyy>gK z>%gnxTA9Oud7i33Q9D)mQZ&tr6az`k9S2RN4TTL~tkUXY?&kwOolfRddHkmM93Lcq z{%F?Far^c~9MD3z@p&2X*SJCZAMH@(Bpev! zX!^pMTz(6T6S^b~o?TpcFkF|v?zD89X;?N^e^@^wNANPBgy@-V@;=t=o5jonUt)&% z;vZY@3+kA&;TW~SnvQx)X8|o{vK98c8o86bWXXu~>_Tn7-CosRBYM`jja$ zbD%$03MjLGd;|17d0eCPsO}3*nL(VvE;QCxzU~>6Rw)W>O|+yG>MNg*V;3fX0)?Do zGx+x=`v$%CjnCN^3l426(+lUqp*Jc_TYD~`@MhHvadR+D#n<&1d2&|WVLw?(S@R^l zMaPAR(RutV$8w16t7wsxAEzh+UgOF^<5Bof2C%Mvd7LlleUs+ zGw;nvClAj{@OdhE)j!9Ct2^; zy@$(?9e8m~_9kWXG_CZb7|TxH^@5nYnOk*CSYh@}UPd=6SB=MkF%kPk_I(f9sC=C0 zeSq8F5qD$o@)r~c)8B6Qb^d;~rRsy>k(n9XfjQiskCP5aoBtSl7pWGSH<8c`7>+jk zuJ~FOR2zn|67RJXlsv$8X`cxZYZ0ZM0rwe{-GtnHsaFim~8} z2+7l`!P-BJ0i&8{wp2Aq>!%r+Zw3l|_V)nQHjOJAS|dK6BnqYbu1XlygZxBBTGE`|;!*;3l7jq3|S0PVNu~;?7l%^KQkU%@dj5&huZ?^?8A}+Gr3B#EosYG=!KtzH&?BI#YfEKHLgICpYwNQ1T0e}i zLT20W*jZv$!X13B7{|2p*7#d+qT9AbRUyHG!@QdGi=U?>{C$BwZ$G5Rmlk(&FQ}c- zpS;zP_*C~@EWN8@G z8F-bBU!FGR5XtMUuhJfQ*F8%Ywu9@)Oe>6)iZ5bR>Sr|=HSqntsZpy0u{FxEc}Q$~ zQgrN22zJ_bHo%K0op4Sse1q)Z?78WWOY5^pk}0tCvY zNZmouvu9J-@1wLdlt>66gy?aSs3^ z8z|3-BoYLoz*3Qi>-k~q<@&~Fbc1_=DQbWxwv~vdFtpVg6&qzu5EBEzc1F?JjLCEv zTE8~L_d)Ses&V;rENI0}X=&}oPCYs|mwvLmQ+f0Cq9GI7yTH^dT~kxjTvMZa;czr* z0o?K5v5^8}NUXSVq&;i4#3318iZi?9M_RNSkE=nsrj)T^ovp~Glm&Q*{Zg+^w=Fb> zDp%|C4{qiY1D?U@`C9qkNxDax)_b$VD`|scTFJDJhZ%u-U z^zED`z8L*$oh#`D+sgBqd3n@LdyzEessX*c-l;&Nf3=4%HCpE~yH_{sI&GIpU0JBD zQfGd7@gY=o+n7osbUEPUr}!_S)_^nPkgIjIdeeP3D-4T(t#_g10hA=!#MbQ@_UDbj zpwNINcBY{XO0^+o_+MR{8m^2N0D!qBL=BwA&cUOSMF?#3|dXr$1k?Nt9wk zY?knUyRG&%(u2r!JFbzO7sDb0D(QM4-2-+=F0DDjRVLo}j}HylCPFm`5K9LLk0?%f-Ae ze?HgQ1PZHu&U3(jBMLx6ytS$Ivzh+q4_7L6Y;zDcSWS|-{$@a%Q--YbCwPYnm zl>jNSvZ^J~sV-bi71R=d#ACcX>Sb!}a22Q(sqBCn2A_?4sJW-}(6~Tg$t0%a)po+^ zgfy`;$6wuA&uE@;nJs6#RQGexntA_PO_T{)eJ%d|P0Ku`R||Ste!o`_yjssRsdXGL z)#ZdXpG}zXlgW@J&>!{CyCL$Pr0XpcKKe3JZq|HvK3n0v?mq@tOV}E*;aIBP)4P1t z&JlAt40PlH#r%t{uEzqQQh|Fz@L!WiO9i`;mUE^xQ}O) zY61!G7ss}tKh@bFI%%5vY(>0Z{Pvm-+!uT?KUrm?Bsc`g`qfD$lPmnkYwV+THWtQ8 zF+@WE>NA`xDGV?wg!tF|6btW$^5P+m2yHMR-Is>YEvbt+FUh_v4R!KzlC56L$e{A7 z9*FpyJJtnHDr9#hp`-rQgwcz;v&k2NSa_t^C%=@K*b5$LVYv)u2@2*-*Sv5;cM9!l z+9_`yH!y+Y@#jCHvY~k%uyZy}28D;?Cq=Bg@U4p38i3E` zO`n)2=ww2IU`exN6_F~;og`7=VX`DE9qk^gJp>&PhprsAwrM`8m#}SPsescZt;mVi zKwmu@*~|k-rHrG{V6RCMzfNr7ov=-_U^KWGx=%39QZH9 z?hsh&NV}Cs_Mi#FK)wuqy5#ZcYfh50$0S8XFJs^?nlQioQ#T3gj^@0Em(8k8E=8TE z1X?i2C3qIhbA!*Pe@q-dAYKEP*_*D)l}ssbJ|Lw=4e)=P>kD%~XuY_uA}jM zTs?-j>CeUCa;NsVT*ziov=**dcQ>uYW593354}c5@@#q&g8$xKg!4&T1n!B>;<(|B zJTk|rCKf*BN+*-PWM&*lFuVn8!a9O0p-Hxze!+A?P5W(~{55bs~96 zxM4Mzh#j7Oco2FnW)k&cn8)dX&tIxzS#Fw;aQECYk9G{aF6`2J`Xn{*X}Rz{>!rz3QDXYD7(4=FD&;V%kfzYt04n)In| zvFr@PPU4p)v^XB%acvSxzk?q=)Ra0KE6f}wWq6Vm-Ch$}^enmuUp5BtBz83r1#^;Z z;(+$@qdELg&fK#-p*(^yo46!-@NC7K5Zo`n*NU!`Nx}O$D9w{8@Tk&%$6e~^aCxX zVhKRK>wJ>NUbimu{W^!KM>n-CllxjQ?TTkVdnO%r-bORw3=mQ8-`d60kbjz?>KKG~ z>_9jq^*mm|w&Z!R96qG+ikB3NL8HqGi#!3*3{HA<7jL&y*-6^@p`$v9pIMG0fHip7 zi*#U`S)2|3l7LIiKmZ&5{IK6+CCGBFkq0N6&1lb3q9B&wt)z9XA&Y-*?SygMAqhT} zKr$3&54niJ2S}?L*XU5KwCf1edr}ox7X7W(*XZ`A(h>RjRdkcC~W%3#nJXNJP$+R7i;rU^T zTdk0g%%?%6$qvRV#QX@0xI)@!qOMTX_JdhP;%bWIfJenK4WaE(rCy!#!|=p0nm&Wh zx^Q!Of3HV$8V%|iH|WH%HB;-vQOla+fHie{e{*1ADI~P@2g5ELhS~Ts{s6sG{;sf) zIjCL|sJ;#-lcwv82DYO=nr-V9w~{nYSqz$H*=HBvq6qef2{?0Q>$-^yb|%Ui#j1QQ zo;*JSM3ep+YxQvD6@!otnJ1Lr(OJ6KXQXe!gpt7MY$5P~VgmO~=W1Hrs|`#<%t;3R zFBUTt_Zl8{MqGdU(`*4NOi6s{4~XorExiOhXz3#jzQPAV)qc#I0|;>iPKx;B0)2N_ zn_CIYuR+ls$}9xuip{m!Z~XkZtPUcpkQ@T&*_*(+w3D+F1Yfh5vJrdCJ^f35N~5G3 zsZqD^{WcjYjt3o&j++nNS^q$50ZS5_W`HJ_BudY89`zqK;a8M@yAOzu$?LegSmgi9 zuohe0-O}Uqy?^k8i^L~O?aeTMwe=19fF#`Uy;OEc`Jjs5G-Q@a{x;R4q`zDxrf>~7 zeqRVlp6m|cz5Onk&t#UQR50#I9`bWW8OCN(m&AkV_MIsY?}h35RWJ+*Kein>Kd5oQ zz#(pd`ZFo0)+txe=1LVcaPPHb-s9NRQsRh&>ACf}v>yL>B>a%z1V;)^C@+DyJ(rzX zDY{?akX-_+TeK|tDXWv;`g&kdS8f3Lf%Z{7iozy!U&x}{nN&J5R3|yxu(SST6dNO& zv0Kl%ug>$i#k#*pWBnpQr_Ow@A<2nXyH&mRE6Q%vbkdF9{>^=Fon^bBp8|0D*cwQ} zf)7d7TO%r_OBe9zMAC$$?k`uv`EJI{M!mBgvSkg|ymb78y7`~S*~SsvHirUNzf7{7 za6Vc~r!$%1Ck{61IAMlG&HBu`1k+}-=mxH>3$HU`b$PKz?bc43O9h^v+Kd|z7PgPX z6fJ;haUh0LLGT5RE{y2orR;30(6PAqv@QCXKS=I}o1E2R3T*G=me-;M4cq-urQSfO zVsS6Ce`6D95%8p;RA2f*7YINX`I31H6o*&8aArhbCd)9#81P=X{X)HmG997`Icr4HCmhPKza;4-bHFDa|~2&fr)LR5h@G)2+@ zw|A^o%7Dj|z>dh%vBYDL-lJc($=txExGp2 z5XI!+a=8*0%4SRe2U@n)T#GcqkV4N+1g!V*;LyvgnXoU|35^b(a@G{8F((GJBx|9Q zkzOzVp75UrhY?1qZx4_k#-&>n7O!uO)LpnRbD1GJK&_jlRTr0$rhjZWc?o`Zv4%Ga z$=p4SS%L~5shwsR2o#X~5hLtCZjBy#5Ag(S^6pY;r%)d>08Cjhm~{obmM%+8E(KiM z!nd()L;4l-2}ekBbo+Fkjo@Wk+GiA<1D%ly8PB#MXthBSdux)*Vik;PuO1lNfsTwU`t3NZU*DR3k z*8OwF$^`2vrlpr}Q*t=OX;y4^_MIFxruyV=IwkXf8>(0lEh6Ax`L@ymJEf0?FwyzJ z<41J((xiBDt4_(z871j$U9S{4k*nR2#)Jvlp-Zg#DP^#) z*BwsjK-qCikh;_Qa5opJ5H=^pUt^mx%t!*Kw6OXUON8`%YOsrTxOaniGlw#sW9}EOkRg-aA(@EgZ2}Nwj?AV&#vB zKNj|RlNBT570RG)HB9si;=XWn=b;n)2^^vm*m1FfDZbt+QvI#lLMd5l1)#B-&A?GG zqadeno*h_vKN!c+AhyumDHUhl@9g2`FDVxk{V`cSbXMK{r?C#o`6{Wlm{#R3#YDjq zK>Fo;CDblT{3`0|5IeFeOZPK8@>JSSA^+Iayg zTXtEWt#A98ji2n>N8ZZ|7PgOE?Qn<%z;mFkbMoi7xaMg*vp#=Fs@}uL>Bb%ED-|}X z^P8U2Vd*f%5(xE4n#_~4+B!NGIE^EzmiqDm{wgo|@yP;P6kd{NP9NygK)?+}ykbx`i)Cx3AY?rQY!{ziE2&0IyOb!h4gJF>6y$M{$es z(R5cRp&cHWztx10eDuZ15~z`rQgf|Hh-o-|zlx<=UsZ&KjkF!9dT+3zw<3!rk!1TB z1EKbe$79K@;ad2<{)*2lb;RuX|GVZ8GS`9rkKFXXYSTY;<)6#~0yX2O7MhDmpd~05 wJ8!H1C{S8z7-(IF3SIf%TGjsvI{zL0PrLsVzX?+h5HzW57UZ}k(0`Ht0w<9@ivR!s diff --git a/design/jsonapi.svg b/design/jsonapi.svg index 46b672e95..2971aeaf4 100644 --- a/design/jsonapi.svg +++ b/design/jsonapi.svg @@ -1 +1 @@ -{} \ No newline at end of file + \ No newline at end of file From af39622045238e8887b1d2aabf07e9ec107497ed Mon Sep 17 00:00:00 2001 From: Ajay Patel Date: Tue, 6 Sep 2022 22:56:51 +0530 Subject: [PATCH 53/93] Added binarcode/laravel-restify in PHP section. Added binarcode/laravel-restify in PHP section. --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index 5647d62b7..b51d4d339 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -183,6 +183,7 @@ and writing of JSON:API documents. * [bednic/json-api](https://gitlab.com/bednic/json-api) Annotation driven library for creating valid JSON API response document from your objects. * [pz/doctrine-rest](https://github.com/R3VoLuT1OneR/doctrine-rest) library provides basic tools for implementation of JSON:API with Doctrine 2 * [pz/jsonapi-resource](https://github.com/R3VoLuT1OneR/jsonapi-resource) Serialize PHP class object into JSON:API resource object using PHP 8.0 Attributes. +* [binarcode/laravel-restify](https://github.com/binarcode/laravel-restify) The fastest way to make a powerful JSON:API compatible Rest API with Laravel [Reference Docs](https://restify.binarcode.com/). ### Node.js * [Fortune.js](http://fortune.js.org/) is a library that includes a [comprehensive implementation of JSON:API](https://github.com/fortunejs/fortune-json-api). From 81c365b218671b7df573940f4269841925d54d30 Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Thu, 29 Sep 2022 16:49:00 -0400 Subject: [PATCH 54/93] Finalize v1.1 --- _config.yml | 7 ++----- _format/1.1/index.md | 7 ------- 2 files changed, 2 insertions(+), 12 deletions(-) diff --git a/_config.yml b/_config.yml index 3ece1ccec..d21969628 100644 --- a/_config.yml +++ b/_config.yml @@ -87,13 +87,10 @@ defaults: is_spec_page: false show_sidebar: true -latest_version: 1.0 +latest_version: 1.1 excerpt_separator: "" announcement: | - **[JSON:API v1.1 RC4](/format/1.1/) has been published! 🎉** - - Please review and try out this upcoming version of the spec before its planned - release date of **September 30, 2022**. + **[JSON:API v1.1](/format/) was finalized September 30, 2022! 🎉** navigation: - title: JSON API diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 63e6a270f..54a96e775 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -1,14 +1,7 @@ --- version: 1.1 -status: rc --- -> **ATTENTION:** As of August 22, 2022, this release candidate is considered -> feature complete. It will be released as the next official version of the -> JSON:API specification on **September 30, 2022** unless any significant -> changes are required. Please review and try out this release candidate prior -> to its finalization. - ## Introduction JSON:API is a specification for how a client should request that resources be From 81c3dd9b10f73064aa1189f30223d29c576f8753 Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Thu, 29 Sep 2022 16:49:21 -0400 Subject: [PATCH 55/93] Add v1.2 draft --- _format/1.2/index.md | 2248 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 2248 insertions(+) create mode 100644 _format/1.2/index.md diff --git a/_format/1.2/index.md b/_format/1.2/index.md new file mode 100644 index 000000000..f647647a4 --- /dev/null +++ b/_format/1.2/index.md @@ -0,0 +1,2248 @@ +--- +version: 1.2 +status: draft +--- + +## Introduction + +JSON:API is a specification for how a client should request that resources be +fetched or modified, and how a server should respond to those requests. JSON:API +can be easily extended with [extensions] and [profiles]. + +JSON:API is designed to minimize both the number of requests and the amount of +data transmitted between clients and servers. This efficiency is achieved +without compromising readability, flexibility, or discoverability. + +JSON:API requires use of the JSON:API media type +([`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json)) +for exchanging data. + +## Semantics + +All document members, query parameters, and processing rules defined by +this specification are collectively called "specification semantics". + +Certain document members, query parameters, and processing rules are reserved +for implementors to define at their discretion. These are called "implementation +semantics". + +All other semantics are reserved for potential future use by this specification. + +## Conventions + +The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", +"SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this +document are to be interpreted as described in +[BCP 14](https://tools.ietf.org/html/bcp14) +[[RFC2119](https://tools.ietf.org/html/rfc2119)] +[[RFC8174](https://tools.ietf.org/html/rfc8174)] +when, and only when, they appear in all capitals, as shown here. + +## The JSON:API Media Type + +The JSON:API media type is +[`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json). + +### Media Type Parameters + +The JSON:API specification supports two media type parameters: `ext` and +`profile`, which are used to specify [extensions] and [profiles], respectively. + +> Note: A media type parameter is an extra piece of information that can +accompany a media type. For example, in the header +`Content-Type: text/html; charset="utf-8"`, the media type is `text/html` and +`charset` is a parameter. + +### Extensions + +Extensions provide a means to "extend" the base specification by defining +additional [specification semantics](#semantics). + +Extensions cannot alter or remove specification semantics, nor can they specify +implementation semantics. + +### Profiles + +Profiles provide a means to share a particular usage of the specification among +implementations. + +Profiles can specify [implementation semantics](#semantics), but cannot alter, +add to, or remove specification semantics. + +### Rules for Media Type Parameters + +The JSON:API media type **MUST NOT** be specified with any media type parameters +other than `ext` and `profile`. The `ext` parameter is used to support +[extensions] and the `profile` parameter is used to support [profiles]. + +Extensions and profiles are each uniquely identified by a +[URI](https://tools.ietf.org/html/rfc3986). Visiting an extension's or a +profile's URI **SHOULD** return documentation that describes its usage. The +values of the `ext` and `profile` parameters **MUST** equal a space-separated +(U+0020 SPACE, " ") list of extension or profile URIs, respectively. + +> Note: When serializing the `ext` or `profile` media type parameters, the HTTP +> specification requires that parameter values be surrounded by quotation marks +> (U+0022 QUOTATION MARK, "\""). + +#### Rules for Extensions + +An extension **MAY** impose additional processing rules or further restrictions +and it **MAY** define new object members as described below. + +An extension **MUST NOT** lessen or remove any processing rules, restrictions or +object member requirements defined in this specification or other extensions. + +An extension **MAY** define new members within the document structure defined by +this specification. The rules for extension member names are covered +[below](#extension-members). + +An extension **MAY** define new query parameters. The rules for extension-defined +query parameters are covered [below](#extension-query-parameters). + +When an extension defines new query parameters or document members, the +extension **MUST** define a namespace to guarantee that extensions will never +conflict with current or future versions of this specification. A namespace +**MUST** meet all of the following conditions: + +- A namespace **MUST** contain at least one character. +- A namespace **MUST** contain only these characters: + - U+0061 to U+007A, "a-z" + - U+0041 to U+005A, "A-Z" + - U+0030 to U+0039, "0-9" + +An extension **MUST NOT** define more than one namespace. The namespace used for +all query parameters and document members **MUST** be the same for any given +extension. + +In the following example, an extension with the namespace `version` has +specified a resource object member `version:id` to support per-resource +versioning. This member might appear as follows: + +```json +HTTP/1.1 200 OK +Content-Type: application/vnd.api+json; ext="https://jsonapi.org/ext/version" + +// ... +{ + "type": "articles", + "id": "1", + "version:id": "42", + "attributes": { + "title": "Rails is Omakase" + } +} +// ... +``` + +#### Rules for Profiles + +The rules for profile usage are dictated by [RFC +6906](https://tools.ietf.org/html/rfc6906). + +A profile **MAY** define document members and processing rules that are reserved +for implementors. + +A profile **MUST NOT** define any query parameters. + +A profile **MUST NOT** alter or remove processing rules that have been defined +by this specification or by an [extension][extensions]. However, a profile +**MAY** define processing rules for query parameters whose processing rules +have been reserved for implementors to define at their discretion. + +For example, a profile could define rules for interpreting [the `filter` query +parameter](#fetching-filtering), but it could not specify that relationship +names in [the `include` query parameter](#fetching-includes) are +space-separated instead of dot-separated. + +Unlike extensions, profiles do not need to define a namespace for document +members because profiles cannot define specification semantics and thus cannot +conflict with current or future versions of this specification. However, it is +possible for profiles to conflict with other profiles. Therefore, it is the +responsibility of implementors to ensure that they do not support conflicting +profiles. + +In the following example, a profile has defined a `timestamps` +[attribute][attributes]. According to the profile, the attribute must be an +object containing a `created` member and a `modified` member and these members' +values must use the [RFC 3339](https://tools.ietf.org/html/rfc3339) format. +With such a profile applied, a response might appear as follows: + +```json +HTTP/1.1 200 OK +Content-Type: application/vnd.api+json; profile="https://example.com/resource-timestamps" + +// ... +{ + "type": "articles", + "id": "1", + "attributes": { + "title": "Rails is Omakase", + "timestamps": { + "created": "2020-07-21T12:09:00Z", + "modified": "2020-07-30T10:19:01Z" + } + } +} +// ... +``` + +## Content Negotiation + +### Universal Responsibilities + +Clients and servers **MUST** send all JSON:API payloads using the JSON:API media +type in the `Content-Type` header. + +Clients and servers **MUST** specify the `ext` media type parameter in the +`Content-Type` header when they have applied one or more extensions to a +JSON:API document. + +Clients and servers **MUST** specify the `profile` media type parameters in the +`Content-Type` header when they have applied one or more profiles to a JSON:API +document. + +### Client Responsibilities + +When processing a JSON:API response document, clients **MUST** ignore any +parameters other than `ext` and `profile` parameters in the server's +`Content-Type` header. + +A client **MAY** use the `ext` media type parameter in an `Accept` header to +require that a server apply all the specified extensions to the response +document. + +A client **MAY** use the `profile` media type parameter in an `Accept` header +to request that the server apply one or more profiles to the response document. + +> Note: A client is allowed to send more than one acceptable media type in the +`Accept` header, including multiple instances of the JSON:API media type. This +allows clients to request different combinations of the `ext` and `profile` +media type parameters. A client can use [quality values](https://tools.ietf.org/html/rfc7231#section-5.3.2) +to indicate that some combinations are less preferable than others. Media types +specified without a qvalue are equally preferable to each other, regardless of +their order, and are always considered more preferable than a media type with a +qvalue less than 1. + +### Server Responsibilities + +If a request specifies the `Content-Type` header with the JSON:API media type, +servers **MUST** respond with a `415 Unsupported Media Type` status code if +that media type contains any media type parameters other than `ext` or +`profile`. + +If a request specifies the `Content-Type` header with an instance of +the JSON:API media type modified by the `ext` media type parameter and that +parameter contains an unsupported extension URI, the server **MUST** respond +with a `415 Unsupported Media Type` status code. + +> Note: JSON:API servers that do not support version 1.1 of this specification + will respond with a `415 Unsupported Media Type` client error if the `ext` or + `profile` media type parameter is present. + +If a request's `Accept` header contains an instance of the JSON:API media type, +servers **MUST** ignore instances of that media type which are modified by a +media type parameter other than `ext` or `profile`. If all instances of that +media type are modified with a media type parameter other than `ext` or `profile`, +servers **MUST** respond with a `406 Not Acceptable` status code. If every +instance of that media type is modified by the `ext` parameter and each contains +at least one unsupported extension URI, the server **MUST** also respond with a +`406 Not Acceptable`. + +If the `profile` parameter is received, a server **SHOULD** attempt to apply any +requested profile(s) to its response. A server **MUST** ignore any profiles +that it does not recognize. + +> Note: The above rules guarantee strict agreement on extensions between the + client and server, while the application of profiles is left to the discretion + of the server. + +Servers that support the `ext` or `profile` media type parameters **SHOULD** +specify the `Vary` header with `Accept` as one of its values. This applies to +responses with and without any [profiles] or [extensions] applied. + +> Note: Some HTTP intermediaries (e.g. CDNs) may ignore the `Vary` header +unless specifically configured to respect it. + +## Document Structure + +This section describes the structure of a JSON:API document, which is identified +by the [JSON:API media type](#content-negotiation-all). JSON:API documents are +defined in JavaScript Object Notation (JSON) [[RFC8259](http://tools.ietf.org/html/rfc8259)]. + +Although the same media type is used for both request and response documents, +certain aspects are only applicable to one or the other. These differences are +called out below. + +Extensions **MAY** define new members within the document structure. These +members **MUST** comply with the naming requirements specified +[below](#extension-members). + +Unless otherwise noted, objects defined by this specification or any applied +extensions **MUST NOT** contain any additional members. Client and server +implementations **MUST** ignore non-compliant members. + +> Note: These conditions allow this specification to evolve through additive +changes. + +### Top Level + +A JSON object **MUST** be at the root of every JSON:API request and response +document containing data. This object defines a document's "top level". + +A document **MUST** contain at least one of the following top-level members: + +* `data`: the document's "primary data". +* `errors`: an array of [error objects](#errors). +* `meta`: a [meta object][meta] that contains non-standard + meta-information. +* a member defined by an applied [extension](#extensions). + +The members `data` and `errors` **MUST NOT** coexist in the same document. + +A document **MAY** contain any of these top-level members: + +* `jsonapi`: an object describing the server's implementation. +* `links`: a [links object][links] related to the primary data. +* `included`: an array of [resource objects] that are related to the primary + data and/or each other ("included resources"). + +If a document does not contain a top-level `data` key, the `included` member +**MUST NOT** be present either. + +The top-level [links object][links] **MAY** contain the following members: + +* `self`: the [link][links] that generated the current response document. If a + document has extensions or profiles applied to it, this link **SHOULD** be + represented by a [link object] with the `type` target attribute specifying the + JSON:API media type with all applicable parameters. +* `related`: a [related resource link] when the primary data represents a + resource relationship. +* `describedby`: a [link] to a description document (e.g. OpenAPI or JSON + Schema) for the current document. +* [pagination] links for the primary data. + +> Note: The `self` link in the top-level `links` object allows a client to +> refresh the data represented by the current response document. The client +> should be able to use the provided link without applying any additional +> information. Therefore the link must contain the query parameters provided +> by the client to generate the response document. This includes but is not +> limited to query parameters used for [inclusion of related resources][fetching resources], +> [sparse fieldsets][fetching sparse fieldsets], [sorting][fetching sorting], +> [pagination][fetching pagination] and [filtering][fetching filtering]. + +The document's "primary data" is a representation of the resource or collection +of resources targeted by a request. + +Primary data **MUST** be either: + +* a single [resource object][resource objects], a single [resource identifier object], or `null`, + for requests that target single resources +* an array of [resource objects], an array of + [resource identifier objects][resource identifier object], or + an empty array (`[]`), for requests that target resource collections + +For example, the following primary data is a single resource object: + +```json +{ + "data": { + "type": "articles", + "id": "1", + "attributes": { + // ... this article's attributes + }, + "relationships": { + // ... this article's relationships + } + } +} +``` + +The following primary data is a single [resource identifier object] that +references the same resource: + +```json +{ + "data": { + "type": "articles", + "id": "1" + } +} +``` + +A logical collection of resources **MUST** be represented as an array, even if +it only contains one item or is empty. + +### Resource Objects + +"Resource objects" appear in a JSON:API document to represent resources. + +A resource object **MUST** contain at least the following top-level members: + +* `id` +* `type` + +Exception: The `id` member is not required when the resource object originates +at the client and represents a new resource to be created on the server. In that +case, a client **MAY** include a `lid` member to uniquely identify the resource +by `type` _locally_ within the document. + +In addition, a resource object **MAY** contain any of these top-level members: + +* `attributes`: an [attributes object][attributes] representing some of the resource's data. +* `relationships`: a [relationships object][relationships] describing relationships between + the resource and other JSON:API resources. +* `links`: a [links object][links] containing links related to the resource. +* `meta`: a [meta object][meta] containing non-standard meta-information about a + resource that can not be represented as an attribute or relationship. + +Here's how an article (i.e. a resource of type "articles") might appear in a document: + +```json +// ... +{ + "type": "articles", + "id": "1", + "attributes": { + "title": "Rails is Omakase" + }, + "relationships": { + "author": { + "links": { + "self": "/articles/1/relationships/author", + "related": "/articles/1/author" + }, + "data": { "type": "people", "id": "9" } + } + } +} +// ... +``` + +#### Identification + +As noted above, every [resource object][resource objects] **MUST** contain a +`type` member. Every resource object **MUST** also contain an `id` member, +except when the resource object originates at the client and represents a new +resource to be created on the server. If `id` is omitted due to this exception, +a `lid` member **MAY** be included to uniquely identify the resource by `type` +_locally_ within the document. The value of the `lid` member **MUST** be +identical for every representation of the resource in the document, including +[resource identifier objects][resource identifier object]. + +The values of the `id`, `type`, and `lid` members **MUST** be strings. + +Within a given API, each resource object's `type` and `id` pair **MUST** +identify a single, unique resource. (The set of URIs controlled by a server, +or multiple servers acting as one, constitute an API.) + +The `type` member is used to describe [resource objects] that share common +attributes and relationships. + +The values of `type` members **MUST** adhere to the same constraints as +[member names]. + +> Note: This spec is agnostic about inflection rules, so the value of `type` +can be either plural or singular. However, the same value should be used +consistently throughout an implementation. + +#### Fields + +A resource object's [attributes] and its [relationships] are collectively called +its "[fields]". + +Fields for a [resource object][resource objects] **MUST** share a common namespace with each +other and with `type` and `id`. In other words, a resource can not have an +attribute and relationship with the same name, nor can it have an attribute +or relationship named `type` or `id`. + +##### Attributes + +The value of the `attributes` key **MUST** be an object (an "attributes +object"). Members of the attributes object ("attributes") represent information +about the [resource object][resource objects] in which it's defined. + +Attributes may contain any valid JSON value, including complex data structures +involving JSON objects and arrays. + +Keys that reference related resources (e.g. `author_id`) **SHOULD NOT** appear +as attributes. Instead, [relationships] **SHOULD** be used. + +> Note: See [fields] and [member names] for more restrictions on this container. + +##### Relationships + +The value of the `relationships` key **MUST** be an object (a "relationships +object"). Each member of a relationships object ("relationships") represents +a "relationship" from the [resource object][resource objects] +in which it has been defined to other resource objects. + +Relationships may be to-one or to-many. + +A relationship's name is given by its key. The value at that key **MUST** be an +object ("relationship object"). + + +A "relationship object" **MUST** contain at least one of the following: + +* `links`: a [links object][links] containing at least one of the following: + * `self`: a link for the relationship itself (a "relationship link"). This + link allows the client to directly manipulate the relationship. For example, + removing an `author` through an `article`'s relationship URL would disconnect + the person from the `article` without deleting the `people` resource itself. + When fetched successfully, this link returns the [linkage][resource linkage] + for the related resources as its primary data. + (See [Fetching Relationships](#fetching-relationships).) + * `related`: a [related resource link] + * a member defined by an applied [extension](#extensions). +* `data`: [resource linkage] +* `meta`: a [meta object][meta] that contains non-standard meta-information about the + relationship. +* a member defined by an applied [extension](#extensions). + +A relationship object that represents a to-many relationship **MAY** also contain +[pagination] links under the `links` member, as described below. Any +[pagination] links in a relationship object **MUST** paginate the relationship +data, not the related resources. + +> Note: See [fields] and [member names] for more restrictions on this container. + +##### Related Resource Links + +A "related resource link" provides access to [resource objects][resource objects] [linked][links] +in a [relationship][relationships]. When fetched, the related resource object(s) +are returned as the response's primary data. + +For example, an `article`'s `comments` [relationship][relationships] could +specify a [link][links] that returns a collection of comment [resource objects] +when retrieved through a `GET` request. + +If present, a related resource link **MUST** reference a valid URL, even if the +relationship isn't currently associated with any target resources. Additionally, +a related resource link **MUST NOT** change because its relationship's content +changes. + +##### Resource Linkage + +Resource linkage in a [compound document] allows a client to link together all +of the included [resource objects] without having to `GET` any URLs via [links]. + +Resource linkage **MUST** be represented as one of the following: + +* `null` for empty to-one relationships. +* an empty array (`[]`) for empty to-many relationships. +* a single [resource identifier object] for non-empty to-one relationships. +* an array of [resource identifier objects][resource identifier object] for non-empty to-many relationships. + +> Note: The spec does not impart meaning to order of resource identifier +objects in linkage arrays of to-many relationships, although implementations +may do that. Arrays of resource identifier objects may represent ordered +or unordered relationships, and both types can be mixed in one response +object. + +For example, the following article is associated with an `author`: + +```json +// ... +{ + "type": "articles", + "id": "1", + "attributes": { + "title": "Rails is Omakase" + }, + "relationships": { + "author": { + "links": { + "self": "http://example.com/articles/1/relationships/author", + "related": "http://example.com/articles/1/author" + }, + "data": { "type": "people", "id": "9" } + } + }, + "links": { + "self": "http://example.com/articles/1" + } +} +// ... +``` + +The `author` relationship includes a link for the relationship itself (which +allows the client to change the related author directly), a related resource +link to fetch the resource objects, and linkage information. + +#### Resource Links + +The optional `links` member within each [resource object][resource objects] contains [links] +related to the resource. + +If present, this links object **MAY** contain a `self` [link][links] that +identifies the resource represented by the resource object. + +```json +// ... +{ + "type": "articles", + "id": "1", + "attributes": { + "title": "Rails is Omakase" + }, + "links": { + "self": "http://example.com/articles/1" + } +} +// ... +``` + +A server **MUST** respond to a `GET` request to the specified URL with a +response that includes the resource as the primary data. + +### Resource Identifier Objects + +A "resource identifier object" is an object that identifies an individual +resource. + +A "resource identifier object" **MUST** contain a `type` member. It **MUST** +also contain an `id` member, except when it represents a new resource to be +created on the server. In this case, a `lid` member **MUST** be included that +identifies the new resource. + +The values of the `id`, `type`, and `lid` members **MUST** be strings. + +A "resource identifier object" **MAY** also include a `meta` member, whose value is a [meta] object that +contains non-standard meta-information. + +### Compound Documents + +Servers **MAY** allow responses that include related resources along with the +requested primary resources. Such responses are called "compound documents". + +In a compound document, all included resources **MUST** be represented as an +array of [resource objects] in a top-level `included` member. + +Every included resource object **MUST** be identified via a chain of +relationships originating in a document's primary data. This means that +compound documents require "full linkage" and that no resource object can be +included without a direct or indirect relationship to the document's primary +data. + +The only exception to the full linkage requirement is when relationship fields +that would otherwise contain linkage data are excluded due to +[sparse fieldsets](#fetching-sparse-fieldsets) requested by the client. + +A complete example document with multiple included relationships: + +```json +{ + "data": [{ + "type": "articles", + "id": "1", + "attributes": { + "title": "JSON:API paints my bikeshed!" + }, + "links": { + "self": "http://example.com/articles/1" + }, + "relationships": { + "author": { + "links": { + "self": "http://example.com/articles/1/relationships/author", + "related": "http://example.com/articles/1/author" + }, + "data": { "type": "people", "id": "9" } + }, + "comments": { + "links": { + "self": "http://example.com/articles/1/relationships/comments", + "related": "http://example.com/articles/1/comments" + }, + "data": [ + { "type": "comments", "id": "5" }, + { "type": "comments", "id": "12" } + ] + } + } + }], + "included": [{ + "type": "people", + "id": "9", + "attributes": { + "firstName": "Dan", + "lastName": "Gebhardt", + "twitter": "dgeb" + }, + "links": { + "self": "http://example.com/people/9" + } + }, { + "type": "comments", + "id": "5", + "attributes": { + "body": "First!" + }, + "relationships": { + "author": { + "data": { "type": "people", "id": "2" } + } + }, + "links": { + "self": "http://example.com/comments/5" + } + }, { + "type": "comments", + "id": "12", + "attributes": { + "body": "I like XML better" + }, + "relationships": { + "author": { + "data": { "type": "people", "id": "9" } + } + }, + "links": { + "self": "http://example.com/comments/12" + } + }] +} +``` + +A [compound document] **MUST NOT** include more than one [resource object][resource objects] for +each `type` and `id` pair. + +> Note: In a single document, you can think of the `type` and `id` as a +composite key that uniquely references [resource objects] in another part of +the document. + +> Note: For resources that do not contain an `id` member but do contain a `lid`, +the `lid` is sufficient to establish resource identity and thus linkage between +resource objects and resource identifier objects throughout the document. + +> Note: This approach ensures that a single canonical [resource object][resource objects] is +returned with each response, even when the same resource is referenced +multiple times. + +### Meta Information + +Where specified, a `meta` member can be used to include non-standard +meta-information. The value of each `meta` member **MUST** be an object (a +"meta object"). + +Any members **MAY** be specified within `meta` objects. + +For example: + +```json +{ + "meta": { + "copyright": "Copyright 2015 Example Corp.", + "authors": [ + "Yehuda Katz", + "Steve Klabnik", + "Dan Gebhardt", + "Tyler Kellen" + ] + }, + "data": { + // ... + } +} +``` + +### Links + +Where specified, a `links` member can be used to represent links. The value +of this member **MUST** be an object (a "links object"). + + +Within this object, a link **MUST** be represented as either: + +* a string whose value is a URI-reference [[RFC3986 Section 4.1](https://tools.ietf.org/html/rfc3986#section-4.1)] + pointing to the link's target, +* a [link object] or +* `null` if the link does not exist. + +A link's relation type **SHOULD** be inferred from the name of the link unless the +link is a [link object] and the link object has a `rel` member. + +A link's context is the [top-level object][top level], [resource +object][resource objects], or [relationship object][relationships] in which it +appears. + +In the example below, the `self` link is a string whereas the `related` link is +a [link object]. The `related` link object provides additional information +about the targeted related resource collection as well as a schema that serves +as a description document for that collection: + +```json +"links": { + "self": "http://example.com/articles/1/relationships/comments", + "related": { + "href": "http://example.com/articles/1/comments", + "title": "Comments", + "describedby": "http://example.com/schemas/article-comments", + "meta": { + "count": 10 + } + } +} +``` + +#### Link objects + +A "link object" is an object that represents a [web link](https://tools.ietf.org/html/rfc8288). + +A link object **MUST** contain the following member: + +* `href`: a string whose value is a URI-reference [[RFC3986 Section 4.1](https://tools.ietf.org/html/rfc3986#section-4.1)] + pointing to the link's target. + +A link object **MAY** also contain any of the following members: + +* `rel`: a string indicating the link's relation type. The string **MUST** be a + [valid link relation type](https://tools.ietf.org/html/rfc8288#section-2.1). +* `describedby`: a [link] to a description document (e.g. OpenAPI or JSON + Schema) for the link target. +* `title`: a string which serves as a label for the destination of a link + such that it can be used as a human-readable identifier (e.g., a menu + entry). +* `type`: a string indicating the media type of the link's target. +* `hreflang`: a string or an array of strings indicating the language(s) of the + link's target. An array of strings indicates that the link's target is + available in multiple languages. Each string **MUST** be a valid language tag + [[RFC5646](https://tools.ietf.org/html/rfc5646)]. +* `meta`: a meta object containing non-standard meta-information about the + link. + +> Note: the `type` and `hreflang` members are only hints; the target resource +> is not guaranteed to be available in the indicated media type or language +> when the link is actually followed. + +### JSON:API Object + +A JSON:API document **MAY** include information about its implementation +under a top level `jsonapi` member. If present, the value of the `jsonapi` +member **MUST** be an object (a "jsonapi object"). + +The jsonapi object **MAY** contain any of the following members: + +* `version` - whose value is a string indicating the highest JSON:API version + supported. +* `ext` - an array of URIs for all applied [extensions]. +* `profile` - an array of URIs for all applied [profiles]. +* `meta` - a [meta] object that contains non-standard meta-information. + +Clients and servers **MUST NOT** use an `ext` or `profile` member for content +negotiation. Content negotiation **MUST** only happen based on media type +parameters in `Content-Type` header. + +A simple example appears below: + +```json +{ + "jsonapi": { + "version": "1.1", + "ext": [ + "https://jsonapi.org/ext/atomic" + ], + "profile": [ + "http://example.com/profiles/flexible-pagination", + "http://example.com/profiles/resource-versioning" + ] + } +} +``` + +If the `version` member is not present, clients should assume the server +implements at least version 1.0 of the specification. + +> Note: Because JSON:API is committed to making additive changes only, the +version string primarily indicates which new features a server may support. + +### Member Names + +Implementation and profile defined member names used in a JSON:API document +**MUST** be treated as case sensitive by clients and servers, and they **MUST** +meet all of the following conditions: + +- Member names **MUST** contain at least one character. +- Member names **MUST** contain only the allowed characters listed below. +- Member names **MUST** start and end with a "globally allowed character", + as defined below. + +To enable an easy mapping of member names to URLs, it is **RECOMMENDED** that +member names use only non-reserved, URL safe characters specified in [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-2.3). + +#### Allowed Characters + +The following "globally allowed characters" **MAY** be used anywhere in a member name: + +- U+0061 to U+007A, "a-z" +- U+0041 to U+005A, "A-Z" +- U+0030 to U+0039, "0-9" +- U+0080 and above (non-ASCII Unicode characters; _not recommended, not URL safe_) + +Additionally, the following characters are allowed in member names, except as the +first or last character: + +- U+002D HYPHEN-MINUS, "-" +- U+005F LOW LINE, "_" +- U+0020 SPACE, " " _(not recommended, not URL safe)_ + +#### Reserved Characters + +The following characters **MUST NOT** be used in implementation and +[profile][profiles] defined member names: + +- U+002B PLUS SIGN, "+" _(has overloaded meaning in URL query strings)_ +- U+002C COMMA, "," _(used as a separator between relationship paths)_ +- U+002E PERIOD, "." _(used as a separator within relationship paths)_ +- U+005B LEFT SQUARE BRACKET, "[" _(used in query parameter families)_ +- U+005D RIGHT SQUARE BRACKET, "]" _(used in query parameter families)_ +- U+0021 EXCLAMATION MARK, "!" +- U+0022 QUOTATION MARK, '"' +- U+0023 NUMBER SIGN, "#" +- U+0024 DOLLAR SIGN, "$" +- U+0025 PERCENT SIGN, "%" +- U+0026 AMPERSAND, "&" +- U+0027 APOSTROPHE, "'" +- U+0028 LEFT PARENTHESIS, "(" +- U+0029 RIGHT PARENTHESIS, ")" +- U+002A ASTERISK, "*" +- U+002F SOLIDUS, "/" +- U+003A COLON, ":" +- U+003B SEMICOLON, ";" +- U+003C LESS-THAN SIGN, "<" +- U+003D EQUALS SIGN, "=" +- U+003E GREATER-THAN SIGN, ">" +- U+003F QUESTION MARK, "?" +- U+0040 COMMERCIAL AT, "@" (except as first character in [@-Members](#document-member-names-at-members)) +- U+005C REVERSE SOLIDUS, "\" +- U+005E CIRCUMFLEX ACCENT, "^" +- U+0060 GRAVE ACCENT, "`" +- U+007B LEFT CURLY BRACKET, "{" +- U+007C VERTICAL LINE, "|" +- U+007D RIGHT CURLY BRACKET, "}" +- U+007E TILDE, "~" +- U+007F DELETE +- U+0000 to U+001F (C0 Controls) + +#### @-Members + +Member names **MAY** also begin with an at sign (U+0040 COMMERCIAL AT, "@"). +Members named this way are called "@-Members". @-Members **MAY** appear +anywhere in a document. + +This specification provides no guidance on the meaning or usage of @-Members, +which are considered to be [implementation semantics](#semantics). @-Members +**MUST** be ignored when interpreting this specification's definitions and +processing instructions given outside of this subsection. For example, an +[attribute][attributes] is defined above as any member of the attributes object. +However, because @-Members must be ignored when interpreting that definition, an +@-Member that occurs in an attributes object is not an attribute. + +> Note: Among other things, "@" members can be used to add JSON-LD data to a +JSON:API document. Such documents should be served with [an extra header](http://www.w3.org/TR/json-ld/#interpreting-json-as-json-ld) +to convey to JSON-LD clients that they contain JSON-LD data. + +#### Extension Members + +The name of every new member introduced by an extension **MUST** be prefixed +with the [extension's namespace](#extension-rules) followed by a colon (`:`). +The remainder of the name **MUST** adhere to the rules for implementation +defined [member names]. + +## Fetching Data + +Data, including resources and relationships, can be fetched by sending a +`GET` request to an endpoint. + +Responses can be further refined with the optional features described below. + +### Fetching Resources + +A server **MUST** support fetching resource data for every URL provided as: + +* a `self` link as part of the top-level links object +* a `self` link as part of a resource-level links object +* a `related` link as part of a relationship-level links object + +For example, the following request fetches a collection of articles: + +```http +GET /articles HTTP/1.1 +Accept: application/vnd.api+json +``` + +The following request fetches an article: + +```http +GET /articles/1 HTTP/1.1 +Accept: application/vnd.api+json +``` + +And the following request fetches an article's author: + +```http +GET /articles/1/author HTTP/1.1 +Accept: application/vnd.api+json +``` + +#### Responses + +##### 200 OK + +A server **MUST** respond to a successful request to fetch an individual +resource or resource collection with a `200 OK` response. + +A server **MUST** respond to a successful request to fetch a resource +collection with an array of [resource objects] or an empty array (`[]`) as +the response document's primary data. + +For example, a `GET` request to a collection of articles could return: + +```http +HTTP/1.1 200 OK +Content-Type: application/vnd.api+json + +{ + "links": { + "self": "http://example.com/articles" + }, + "data": [{ + "type": "articles", + "id": "1", + "attributes": { + "title": "JSON:API paints my bikeshed!" + } + }, { + "type": "articles", + "id": "2", + "attributes": { + "title": "Rails is Omakase" + } + }] +} +``` + +A similar response representing an empty collection would be: + +```http +HTTP/1.1 200 OK +Content-Type: application/vnd.api+json + +{ + "links": { + "self": "http://example.com/articles" + }, + "data": [] +} +``` + +A server **MUST** respond to a successful request to fetch an individual +resource with a [resource object][resource objects] or `null` provided as +the response document's primary data. + +`null` is only an appropriate response when the requested URL is one that +might correspond to a single resource, but doesn't currently. + +> Note: Consider, for example, a request to fetch a to-one related resource link. +This request would respond with `null` when the relationship is empty (such that +the link is corresponding to no resources) but with the single related resource's +[resource object][resource objects] otherwise. + +For example, a `GET` request to an individual article could return: + +```http +HTTP/1.1 200 OK +Content-Type: application/vnd.api+json + +{ + "links": { + "self": "http://example.com/articles/1" + }, + "data": { + "type": "articles", + "id": "1", + "attributes": { + "title": "JSON:API paints my bikeshed!" + }, + "relationships": { + "author": { + "links": { + "related": "http://example.com/articles/1/author" + } + } + } + } +} +``` + +If the above article's author is missing, then a `GET` request to that related +resource would return: + +```http +HTTP/1.1 200 OK +Content-Type: application/vnd.api+json + +{ + "links": { + "self": "http://example.com/articles/1/author" + }, + "data": null +} +``` + +##### 404 Not Found + +A server **MUST** respond with `404 Not Found` when processing a request to +fetch a single resource that does not exist, except when the request warrants a +`200 OK` response with `null` as the primary data (as described above). + +##### Other Responses + +A server **MAY** respond with other HTTP status codes. + +A server **MAY** include [error details] with error responses. + +A server **MUST** prepare responses, and a client **MUST** interpret +responses, in accordance with +[`HTTP semantics`](http://tools.ietf.org/html/rfc7231). + +### Fetching Relationships + +A server **MUST** support fetching relationship data for every relationship URL +provided as a `self` link as part of a relationship's `links` object. + +For example, the following request fetches data about an article's comments: + +```http +GET /articles/1/relationships/comments HTTP/1.1 +Accept: application/vnd.api+json +``` + +And the following request fetches data about an article's author: + +```http +GET /articles/1/relationships/author HTTP/1.1 +Accept: application/vnd.api+json +``` + +#### Responses + +##### 200 OK + +A server **MUST** respond to a successful request to fetch a relationship +with a `200 OK` response. + +The primary data in the response document **MUST** match the appropriate +value for [resource linkage], as described above for +[relationship objects][relationships]. + +The top-level [links object][links] **MAY** contain `self` and `related` links, +as described above for [relationship objects][relationships]. + +For example, a `GET` request to a URL from a to-one relationship link could +return: + +```http +HTTP/1.1 200 OK +Content-Type: application/vnd.api+json + +{ + "links": { + "self": "/articles/1/relationships/author", + "related": "/articles/1/author" + }, + "data": { + "type": "people", + "id": "12" + } +} +``` + +If the above relationship is empty, then a `GET` request to the same URL would +return: + +```http +HTTP/1.1 200 OK +Content-Type: application/vnd.api+json + +{ + "links": { + "self": "/articles/1/relationships/author", + "related": "/articles/1/author" + }, + "data": null +} +``` + +A `GET` request to a URL from a to-many relationship link could return: + +```http +HTTP/1.1 200 OK +Content-Type: application/vnd.api+json + +{ + "links": { + "self": "/articles/1/relationships/tags", + "related": "/articles/1/tags" + }, + "data": [ + { "type": "tags", "id": "2" }, + { "type": "tags", "id": "3" } + ] +} +``` + +If the above relationship is empty, then a `GET` request to the same URL would +return: + +```http +HTTP/1.1 200 OK +Content-Type: application/vnd.api+json + +{ + "links": { + "self": "/articles/1/relationships/tags", + "related": "/articles/1/tags" + }, + "data": [] +} +``` + +##### 404 Not Found + +A server **MUST** return `404 Not Found` when processing a request to fetch +a relationship link URL that does not exist. + +> Note: This can happen when the parent resource of the relationship +does not exist. For example, when `/articles/1` does not exist, request to +`/articles/1/relationships/tags` returns `404 Not Found`. + +If a relationship link URL exists but the relationship is empty, then +`200 OK` **MUST** be returned, as described above. + +##### Other Responses + +A server **MAY** respond with other HTTP status codes. + +A server **MAY** include [error details] with error responses. + +A server **MUST** prepare responses, and a client **MUST** interpret +responses, in accordance with +[`HTTP semantics`](http://tools.ietf.org/html/rfc7231). + +### Inclusion of Related Resources + +An endpoint **MAY** return resources related to the primary data by default. + +An endpoint **MAY** also support an `include` query parameter to allow the +client to customize which related resources should be returned. + +If an endpoint does not support the `include` parameter, it **MUST** respond +with `400 Bad Request` to any requests that include it. + +If an endpoint supports the `include` parameter and a client supplies it: + + - The server's response **MUST** be a [compound document] with an `included` key — even if that `included` key holds an empty array (because the requested relationships are empty). + - The server **MUST NOT** include unrequested [resource objects] in the `included` +section of the [compound document]. + +The value of the `include` parameter **MUST** be a comma-separated (U+002C +COMMA, ",") list of relationship paths. A relationship path is a dot-separated +(U+002E FULL-STOP, ".") list of [relationship][relationships] names. An empty +value indicates that no related resources should be returned. + +If a server is unable to identify a relationship path or does not support +inclusion of resources from a path, it **MUST** respond with 400 Bad Request. + +> Note: For example, a relationship path could be `comments.author`, where +`comments` is a relationship listed under a `articles` [resource object][resource objects], and +`author` is a relationship listed under a `comments` [resource object][resource objects]. + +For instance, comments could be requested with an article: + +```http +GET /articles/1?include=comments HTTP/1.1 +Accept: application/vnd.api+json +``` + +In order to request resources related to other resources, a dot-separated path +for each relationship name can be specified: + +```http +GET /articles/1?include=comments.author HTTP/1.1 +Accept: application/vnd.api+json +``` + +> Note: Because [compound documents][compound document] require full linkage +(except when relationship linkage is excluded by sparse fieldsets), intermediate +resources in a multi-part path must be returned along with the leaf nodes. For +example, a response to a request for `comments.author` should include `comments` +as well as the `author` of each of those `comments`. + +> Note: A server may choose to expose a deeply nested relationship such as +`comments.author` as a direct relationship with an alternative name such as +`commentAuthors`. This would allow a client to request +`/articles/1?include=commentAuthors` instead of +`/articles/1?include=comments.author`. By exposing the nested relationship with +an alternative name, the server can still provide full linkage in compound +documents without including potentially unwanted intermediate resources. + +Multiple related resources can be requested in a comma-separated list: + +```http +GET /articles/1?include=comments.author,ratings HTTP/1.1 +Accept: application/vnd.api+json +``` + +Furthermore, related resources can be requested from a relationship endpoint: + +```http +GET /articles/1/relationships/comments?include=comments.author HTTP/1.1 +Accept: application/vnd.api+json +``` + +In this case, the primary data would be a collection of +[resource identifier objects][resource identifier object] that represent linkage to comments for an article, +while the full comments and comment authors would be returned as included data. + +> Note: This section applies to any endpoint that responds with primary +data, regardless of the request type. For instance, a server could support +the inclusion of related resources along with a `POST` request to create a +resource or relationship. + +### Sparse Fieldsets + +A client **MAY** request that an endpoint return only specific [fields] in the +response on a per-type basis by including a `fields[TYPE]` query parameter. + +The value of any `fields[TYPE]` parameter **MUST** be a comma-separated (U+002C +COMMA, ",") list that refers to the name(s) of the fields to be returned. +An empty value indicates that no fields should be returned. + +If a client requests a restricted set of [fields] for a given resource type, +an endpoint **MUST NOT** include additional [fields] in resource objects of +that type in its response. + +If a client does not specify the set of [fields] for a given resource type, the +server **MAY** send all fields, a subset of fields, or no fields for that +resource type. + +```http +GET /articles?include=author&fields[articles]=title,body&fields[people]=name HTTP/1.1 +Accept: application/vnd.api+json +``` + +> Note: The above example URI shows unencoded `[` and `]` characters simply for +readability. In practice, these characters should be percent-encoded. See +"[Square Brackets in Parameter Names](#appendix-query-details-square-brackets)". + +> Note: This section applies to any endpoint that responds with resources as +primary or included data, regardless of the request type. For instance, a +server could support sparse fieldsets along with a `POST` request to create +a resource. + +### Sorting + +A server **MAY** choose to support requests to sort resource collections +according to one or more criteria ("sort fields"). + +> Note: Although recommended, sort fields do not necessarily need to +correspond to resource attribute and relationship names. + +> Note: It is recommended that dot-separated (U+002E FULL-STOP, ".") sort +fields be used to request sorting based upon relationship attributes. For +example, a sort field of `author.name` could be used to request that the +primary data be sorted based upon the `name` attribute of the `author` +relationship. + +An endpoint **MAY** support requests to sort the primary data with a `sort` +query parameter. The value for `sort` **MUST** represent sort fields. + +```http +GET /people?sort=age HTTP/1.1 +Accept: application/vnd.api+json +``` + +An endpoint **MAY** support multiple sort fields by allowing comma-separated +(U+002C COMMA, ",") sort fields. Sort fields **SHOULD** be applied in the +order specified. + +```http +GET /people?sort=age,name HTTP/1.1 +Accept: application/vnd.api+json +``` + +The sort order for each sort field **MUST** be ascending unless it is prefixed +with a minus (U+002D HYPHEN-MINUS, "-"), in which case it **MUST** be descending. + +```http +GET /articles?sort=-created,title HTTP/1.1 +Accept: application/vnd.api+json +``` + +The above example should return the newest articles first. Any articles +created on the same date will then be sorted by their title in ascending +alphabetical order. + +If the server does not support sorting as specified in the query parameter +`sort`, it **MUST** return `400 Bad Request`. + +If sorting is supported by the server and requested by the client via query +parameter `sort`, the server **MUST** return elements of the top-level +`data` array of the response ordered according to the criteria specified. +The server **MAY** apply default sorting rules to top-level `data` if +request parameter `sort` is not specified. + +> Note: This section applies to any endpoint that responds with a resource +collection as primary data, regardless of the request type. + +### Pagination + +A server **MAY** choose to limit the number of resources returned in a response +to a subset ("page") of the whole set available. + +A server **MAY** provide links to traverse a paginated data set ("pagination +links"). + +Pagination links **MUST** appear in the links object that corresponds to a +collection. To paginate the primary data, supply pagination links in the +top-level `links` object. To paginate an included collection returned in +a [compound document], supply pagination links in the corresponding links +object. + +The following keys **MUST** be used for pagination links: + +* `first`: the first page of data +* `last`: the last page of data +* `prev`: the previous page of data +* `next`: the next page of data + +Keys **MUST** either be omitted or have a `null` value to indicate that a +particular link is unavailable. + +Concepts of order, as expressed in the naming of pagination links, **MUST** +remain consistent with JSON:API's [sorting rules](#fetching-sorting). + +The `page` [query parameter family] is reserved for pagination. Servers and +clients **SHOULD** use these parameters for pagination operations. + +> Note: JSON API is agnostic about the pagination strategy used by a server, but +> the `page` query parameter family can be used regardless of the strategy +> employed. For example, a page-based strategy might use query parameters such +> as `page[number]` and `page[size]`, while a cursor-based strategy might use +> `page[cursor]`. + +> Note: This section applies to any endpoint that responds with a resource +collection as primary data, regardless of the request type. + +### Filtering + +The `filter` [query parameter family] is reserved for filtering data. Servers +and clients **SHOULD** use these parameters for filtering operations. + +> Note: JSON API is agnostic about the strategies supported by a server. + +## Creating, Updating and Deleting Resources + +A server **MAY** allow resources of a given type to be created. It **MAY** +also allow existing resources to be modified or deleted. + +A request **MUST** completely succeed or fail (in a single "transaction"). No +partial updates are allowed. + +> Note: The `type` member is required in every [resource object][resource objects] throughout requests and +responses in JSON:API. There are some cases, such as when `POST`ing to an +endpoint representing heterogeneous data, when the `type` could not be inferred +from the endpoint. However, picking and choosing when it is required would be +confusing; it would be hard to remember when it was required and when it was +not. Therefore, to improve consistency and minimize confusion, `type` is +always required. + +### Creating Resources + +A resource can be created by sending a `POST` request to a URL that represents +a collection of resources. The request **MUST** include a single [resource object][resource objects] +as primary data. The [resource object][resource objects] **MUST** contain at least a `type` member. + +For instance, a new photo might be created with the following request: + +```http +POST /photos HTTP/1.1 +Content-Type: application/vnd.api+json +Accept: application/vnd.api+json + +{ + "data": { + "type": "photos", + "attributes": { + "title": "Ember Hamster", + "src": "http://example.com/images/productivity.png" + }, + "relationships": { + "photographer": { + "data": { "type": "people", "id": "9" } + } + } + } +} +``` + +If a relationship is provided in the `relationships` member of the +[resource object][resource objects], its value **MUST** be a relationship object with a `data` +member. The value of this key represents the [linkage][resource linkage] the new resource is to +have. + +#### Client-Generated IDs + +A server **MAY** accept a client-generated ID along with a request to create +a resource. An ID **MUST** be specified with an `id` key, the value of +which **MUST** be a universally unique identifier. The client **SHOULD** use +a properly generated and formatted *UUID* as described in RFC 4122 +[[RFC4122](http://tools.ietf.org/html/rfc4122.html)]. + +> NOTE: In some use-cases, such as importing data from another source, it +may be possible to use something other than a UUID that is still guaranteed +to be globally unique. Do not use anything other than a UUID unless you are +100% confident that the strategy you are using indeed generates globally +unique identifiers. + +For example: + +```http +POST /photos HTTP/1.1 +Content-Type: application/vnd.api+json +Accept: application/vnd.api+json + +{ + "data": { + "type": "photos", + "id": "550e8400-e29b-41d4-a716-446655440000", + "attributes": { + "title": "Ember Hamster", + "src": "http://example.com/images/productivity.png" + } + } +} +``` + +A server **MUST** return `403 Forbidden` in response to an unsupported request +to create a resource with a client-generated ID. + +#### Responses + +##### 201 Created + +If the requested resource has been created successfully and the server changes +the resource in any way (for example, by assigning an `id`), the server **MUST** +return a `201 Created` response and a document that contains the resource as +primary data. + +The response **SHOULD** include a `Location` header identifying the location +of the newly created resource, in order to comply with [RFC +7231](http://tools.ietf.org/html/rfc7231#section-6.3.2). + +If the [resource object][resource objects] returned by the response contains a `self` key in its +`links` member and a `Location` header is provided, the value of the `self` +member **MUST** match the value of the `Location` header. + +```http +HTTP/1.1 201 Created +Location: http://example.com/photos/550e8400-e29b-41d4-a716-446655440000 +Content-Type: application/vnd.api+json + +{ + "data": { + "type": "photos", + "id": "550e8400-e29b-41d4-a716-446655440000", + "attributes": { + "title": "Ember Hamster", + "src": "http://example.com/images/productivity.png" + }, + "links": { + "self": "http://example.com/photos/550e8400-e29b-41d4-a716-446655440000" + } + } +} +``` + +A server **MAY** return a `201 Created` response with a document that contains +no primary data if the requested resource has been created successfully and the +server does not change the resource in any way (for example, by assigning an +`id` or `createdAt` attribute). Other top-level members, such as [meta], could +be included in the response document. + +> Note: Only servers that accept [Client-Generated +IDs](#crud-creating-client-ids) can avoid assigning an `id` to a new resource. + +##### 202 Accepted + +If a request to create a resource has been accepted for processing, but the +processing has not been completed by the time the server responds, the +server **MUST** return a `202 Accepted` status code. + +##### 204 No Content + +If the requested resource has been created successfully and the server does not +change the resource in any way (for example, by assigning an `id` or `createdAt` +attribute), the server **MUST** return either a `201 Created` status code and +response document (as described above) or a `204 No Content` status code with no +response document. + +##### 403 Forbidden + +A server **MAY** return `403 Forbidden` in response to an unsupported request +to create a resource. + +##### 404 Not Found + +A server **MUST** return `404 Not Found` when processing a request that +references a related resource that does not exist. + +##### 409 Conflict + +A server **MUST** return `409 Conflict` when processing a `POST` request to +create a resource with a client-generated ID that already exists. + +A server **MUST** return `409 Conflict` when processing a `POST` request in +which the [resource object][resource objects]'s `type` is not among the type(s) that constitute the +collection represented by the endpoint. + +A server **SHOULD** include error details and provide enough information to +recognize the source of the conflict. + +##### Other Responses + +A server **MAY** respond with other HTTP status codes. + +A server **MAY** include [error details] with error responses. + +A server **MUST** prepare responses, and a client **MUST** interpret +responses, in accordance with +[`HTTP semantics`](http://tools.ietf.org/html/rfc7231). + +### Updating Resources + +A resource can be updated by sending a `PATCH` request to the URL that +represents the resource. + +The URL for a resource can be obtained in the `self` link of the resource +object. Alternatively, when a `GET` request returns a single [resource object][resource objects] as +primary data, the same request URL can be used for updates. + +The `PATCH` request **MUST** include a single [resource object][resource objects] as primary data. +The [resource object][resource objects] **MUST** contain `type` and `id` members. + +For example: + +```http +PATCH /articles/1 HTTP/1.1 +Content-Type: application/vnd.api+json +Accept: application/vnd.api+json + +{ + "data": { + "type": "articles", + "id": "1", + "attributes": { + "title": "To TDD or Not" + } + } +} +``` + +#### Updating a Resource's Attributes + +Any or all of a resource's [attributes] **MAY** be included in the resource +object included in a `PATCH` request. + +If a request does not include all of the [attributes] for a resource, the server +**MUST** interpret the missing [attributes] as if they were included with their +current values. The server **MUST NOT** interpret missing attributes as `null` +values. + +For example, the following `PATCH` request is interpreted as a request to +update only the `title` and `text` attributes of an article: + +```http +PATCH /articles/1 HTTP/1.1 +Content-Type: application/vnd.api+json +Accept: application/vnd.api+json + +{ + "data": { + "type": "articles", + "id": "1", + "attributes": { + "title": "To TDD or Not", + "text": "TLDR; It's complicated... but check your test coverage regardless." + } + } +} +``` + +#### Updating a Resource's Relationships + +Any or all of a resource's [relationships] **MAY** be included in the resource +object included in a `PATCH` request. + +If a request does not include all of the [relationships] for a resource, the server +**MUST** interpret the missing [relationships] as if they were included with their +current values. It **MUST NOT** interpret them as `null` or empty values. + +If a relationship is provided in the `relationships` member of a resource +object in a `PATCH` request, its value **MUST** be a relationship object +with a `data` member. The relationship's value will be replaced with the +value specified in this member. + +For instance, the following `PATCH` request will update the `author` relationship of an article: + +```http +PATCH /articles/1 HTTP/1.1 +Content-Type: application/vnd.api+json +Accept: application/vnd.api+json + +{ + "data": { + "type": "articles", + "id": "1", + "relationships": { + "author": { + "data": { "type": "people", "id": "1" } + } + } + } +} +``` + +Likewise, the following `PATCH` request performs a complete replacement of +the `tags` for an article: + +```http +PATCH /articles/1 HTTP/1.1 +Content-Type: application/vnd.api+json +Accept: application/vnd.api+json + +{ + "data": { + "type": "articles", + "id": "1", + "relationships": { + "tags": { + "data": [ + { "type": "tags", "id": "2" }, + { "type": "tags", "id": "3" } + ] + } + } + } +} +``` + +A server **MAY** reject an attempt to do a full replacement of a to-many +relationship. In such a case, the server **MUST** reject the entire update, +and return a `403 Forbidden` response. + +> Note: Since full replacement may be a very dangerous operation, a server +may choose to disallow it. For example, a server may reject full replacement if +it has not provided the client with the full list of associated objects, and +does not want to allow deletion of records the client has not seen. + +#### Responses + +##### 200 OK + +If a server accepts an update but also changes the targeted resource in ways +other than those specified by the request (for example, updating the +`updatedAt` attribute or a computed `sha`), it **MUST** return a `200 OK` +response and a document that contains the updated resource as primary data. + +A server **MAY** return a `200 OK` response with a document that contains no +primary data if an update is successful and the server does not change the +targeted resource in ways other than those specified by the request. Other +top-level members, such as [meta], could be included in the response document. + +##### 202 Accepted + +If an update request has been accepted for processing, but the processing +has not been completed by the time the server responds, the server **MUST** +return a `202 Accepted` status code. + +##### 204 No Content + +If an update is successful and the server doesn't change the targeted +resource in ways other than those specified by the request, the server +**MUST** return either a `200 OK` status code and response document (as +described above) or a `204 No Content` status code with no response document. + +##### 403 Forbidden + +A server **MUST** return `403 Forbidden` in response to an unsupported request +to update a resource or relationship. + +##### 404 Not Found + +A server **MUST** return `404 Not Found` when processing a request to modify +a resource that does not exist. + +A server **MUST** return `404 Not Found` when processing a request that +references a related resource that does not exist. + +##### 409 Conflict + +A server **MAY** return `409 Conflict` when processing a `PATCH` request to +update a resource if that update would violate other server-enforced +constraints (such as a uniqueness constraint on a property other than `id`). + +A server **MUST** return `409 Conflict` when processing a `PATCH` request in +which the resource object's `type` or `id` do not match the server's endpoint. + +A server **SHOULD** include error details and provide enough information to +recognize the source of the conflict. + +##### Other Responses + +A server **MAY** respond with other HTTP status codes. + +A server **MAY** include [error details] with error responses. + +A server **MUST** prepare responses, and a client **MUST** interpret +responses, in accordance with +[`HTTP semantics`](http://tools.ietf.org/html/rfc7231). + +### Updating Relationships + +Although relationships can be modified along with resources (as described +above), JSON:API also supports updating of relationships independently at +URLs from [relationship links][relationships]. + +> Note: Relationships are updated without exposing the underlying server +semantics, such as foreign keys. Furthermore, relationships can be updated +without necessarily affecting the related resources. For example, if an article +has many authors, it is possible to remove one of the authors from the article +without deleting the person itself. Similarly, if an article has many tags, it +is possible to add or remove tags. Under the hood on the server, the first +of these examples might be implemented with a foreign key, while the second +could be implemented with a join table, but the JSON:API protocol would be +the same in both cases. + +> Note: A server may choose to delete the underlying resource if a +relationship is deleted (as a garbage collection measure). + +#### Updating To-One Relationships + +A to-one relationship can be updated by sending a `PATCH` request to a URL +from a to-one [relationship link][relationships]. + +The `PATCH` request **MUST** include a top-level member named `data` containing +one of: + +* a [resource identifier object] corresponding to the new related resource. +* `null`, to remove the relationship. + +For example, the following request updates the author of an article: + +```http +PATCH /articles/1/relationships/author HTTP/1.1 +Content-Type: application/vnd.api+json +Accept: application/vnd.api+json + +{ + "data": { "type": "people", "id": "12" } +} +``` + +And the following request clears the author of the same article: + +```http +PATCH /articles/1/relationships/author HTTP/1.1 +Content-Type: application/vnd.api+json +Accept: application/vnd.api+json + +{ + "data": null +} +``` + +If the relationship is updated successfully then the server **MUST** return +a successful response. + +#### Updating To-Many Relationships + +A to-many relationship can be updated by sending a `PATCH`, `POST`, or +`DELETE` request to a URL from a to-many [relationship link][relationships]. + +For all request types, the body **MUST** contain a `data` member whose value +is an empty array or an array of [resource identifier objects][resource identifier object]. + +If a client makes a `PATCH` request to a URL from a to-many +[relationship link][relationships], the server **MUST** either completely +replace every member of the relationship, return an appropriate error response +if some resources cannot be found or accessed, or return a `403 Forbidden` +response if complete replacement is not allowed by the server. + +For example, the following request replaces every tag for an article: + +```http +PATCH /articles/1/relationships/tags HTTP/1.1 +Content-Type: application/vnd.api+json +Accept: application/vnd.api+json + +{ + "data": [ + { "type": "tags", "id": "2" }, + { "type": "tags", "id": "3" } + ] +} +``` + +And the following request clears every tag for an article: + +```http +PATCH /articles/1/relationships/tags HTTP/1.1 +Content-Type: application/vnd.api+json +Accept: application/vnd.api+json + +{ + "data": [] +} +``` + +If a client makes a `POST` request to a URL from a +[relationship link][relationships], the server **MUST** add the specified +members to the relationship unless they are already present. If a given `type` +and `id` is already in the relationship, the server **MUST NOT** add it again. + +> Note: This matches the semantics of databases that use foreign keys for +has-many relationships. Document-based storage should check the has-many +relationship before appending to avoid duplicates. + +If all of the specified resources can be added to, or are already present +in, the relationship then the server **MUST** return a successful response. + +> Note: This approach ensures that a request is successful if the server's +state matches the requested state, and helps avoid pointless race conditions +caused by multiple clients making the same changes to a relationship. + +In the following example, the comment with ID `123` is added to the list of +comments for the article with ID `1`: + +```http +POST /articles/1/relationships/comments HTTP/1.1 +Content-Type: application/vnd.api+json +Accept: application/vnd.api+json + +{ + "data": [ + { "type": "comments", "id": "123" } + ] +} +``` + +If the client makes a `DELETE` request to a URL from a +[relationship link][relationships] the server **MUST** delete the specified +members from the relationship or return a `403 Forbidden` response. If all of +the specified resources are able to be removed from, or are already missing +from, the relationship then the server **MUST** return a successful response. + +> Note: As described above for `POST` requests, this approach helps avoid +pointless race conditions between multiple clients making the same changes. + +Relationship members are specified in the same way as in the `POST` request. + +In the following example, comments with IDs of `12` and `13` are removed +from the list of comments for the article with ID `1`: + +```http +DELETE /articles/1/relationships/comments HTTP/1.1 +Content-Type: application/vnd.api+json +Accept: application/vnd.api+json + +{ + "data": [ + { "type": "comments", "id": "12" }, + { "type": "comments", "id": "13" } + ] +} +``` + +> Note: RFC 7231 specifies that a DELETE request may include a body, but +that a server may reject the request. This spec defines the semantics of a +server, and we are defining its semantics for JSON:API. + +#### Responses + +##### 200 OK + +If a server accepts an update but also changes the targeted relationship in +other ways than those specified by the request, it **MUST** return a `200 OK` +response and a document that includes the updated relationship data as its +primary data. + +A server **MAY** return a `200 OK` response with a document that contains no +primary data if an update is successful and the server does not change the +targeted relationship in ways other than those specified by the request. Other +top-level members, such as [meta], could be included in the response document. + +##### 202 Accepted + +If a relationship update request has been accepted for processing, but the +processing has not been completed by the time the server responds, the +server **MUST** return a `202 Accepted` status code. + +##### 204 No Content + +If an update is successful and the server doesn't change the targeted +relationship in ways other than those specified by the request, the server +**MUST** return either a `200 OK` status code and response document (as +described above) or a `204 No Content` status code with no response document. + +> Note: This is the appropriate response to a `POST` request sent to a URL +from a to-many [relationship link][relationships] when that relationship already +exists. It is also the appropriate response to a `DELETE` request sent to a URL +from a to-many [relationship link][relationships] when that relationship does +not exist. + +##### 403 Forbidden + +A server **MUST** return `403 Forbidden` in response to an unsupported request +to update a relationship. + +##### Other Responses + +A server **MAY** respond with other HTTP status codes. + +A server **MAY** include [error details] with error responses. + +A server **MUST** prepare responses, and a client **MUST** interpret +responses, in accordance with +[`HTTP semantics`](http://tools.ietf.org/html/rfc7231). + +### Deleting Resources + +A resource can be deleted by sending a `DELETE` request to the URL +that represents the resource: + +```http +DELETE /photos/1 HTTP/1.1 +Accept: application/vnd.api+json +``` + +#### Responses + +##### 200 OK + +A server **MAY** return a `200 OK` response with a document that contains no +primary data if a deletion request is successful. Other top-level members, such +as [meta], could be included in the response document. + +##### 202 Accepted + +If a deletion request has been accepted for processing, but the processing has +not been completed by the time the server responds, the server **MUST** +return a `202 Accepted` status code. + +##### 204 No Content + +If a deletion request is successful, the server **MUST** return either a `200 +OK` status code and response document (as described above) or a `204 No Content` +status code with no response document. + +##### 404 NOT FOUND + +A server **SHOULD** return a `404 Not Found` status code if a deletion request fails +due to the resource not existing. + +##### Other Responses + +A server **MAY** respond with other HTTP status codes. + +A server **MAY** include [error details] with error responses. + +A server **MUST** prepare responses, and a client **MUST** interpret +responses, in accordance with +[`HTTP semantics`](http://tools.ietf.org/html/rfc7231). + +## Query Parameters + +### Query Parameter Families + +Although "query parameter" is a common term in everyday web development, it is +not a well-standardized concept. Therefore, JSON:API provides its own +[definition of a query parameter](#appendix-query-details). + +For the most part, JSON:API's definition coincides with colloquial usage, and its +details can be safely ignored. However, one important consequence of this +definition is that a URL like the following is considered to have two distinct +query parameters: + +``` +/?page[offset]=0&page[limit]=10 +``` + +The two parameters are named `page[offset]` and `page[limit]`; there is no +single `page` parameter. + +In practice, however, parameters like `page[offset]` and `page[limit]` are +usually defined and processed together, and it's convenient to refer to them +collectively. Therefore, JSON:API introduces the concept of a query parameter +family. + +A "query parameter family" is the set of all query parameters whose name starts +with a "base name", followed by zero or more instances of empty square brackets +(i.e. `[]`) or square-bracketed legal [member names]. The family is referred to +by its base name. + +For example, the `filter` query parameter family includes parameters named: +`filter`, `filter[x]`, `filter[]`, `filter[x][]`, `filter[][]`, `filter[x][y]`, +etc. However, `filter[_]` is not a valid parameter name in the family, because +`_` is not a valid [member name][member names]. + +### Extension-Specific Query Parameters + +The base name of every query parameter introduced by an extension **MUST** be +prefixed with the extension's namespace followed by a colon (`:`). The +remainder of the base name **MUST** contain only the characters \[a-z\] (U+0061 +to U+007A, "a-z"). + +### Implementation-Specific Query Parameters + +Implementations **MAY** support custom query parameters. However, the names of +these query parameters **MUST** come from a [family][query parameter family] +whose base name is a legal [member name][member names] and also contains at least +one non a-z character (i.e., outside U+0061 to U+007A). + +It is **RECOMMENDED** that a capital letter (e.g. camelCasing) be used to +satisfy the above requirement. + +If a server encounters a query parameter that does not follow the naming +conventions above, or the server does not know how to process it as a query +parameter from this specification, it **MUST** return `400 Bad Request`. + +> Note: By forbidding the use of query parameters that contain only the characters +> \[a-z\], JSON:API is reserving the ability to standardize additional query +> parameters later without conflicting with existing implementations. + +## Errors + +### Processing Errors + +A server **MAY** choose to stop processing as soon as a problem is encountered, +or it **MAY** continue processing and encounter multiple problems. For instance, +a server might process multiple attributes and then return multiple validation +problems in a single response. + +When a server encounters multiple problems for a single request, the most +generally applicable HTTP error code **SHOULD** be used in the response. For +instance, `400 Bad Request` might be appropriate for multiple 4xx errors +or `500 Internal Server Error` might be appropriate for multiple 5xx errors. + +### Error Objects + +Error objects provide additional information about problems encountered while +performing an operation. Error objects **MUST** be returned as an array +keyed by `errors` in the top level of a JSON:API document. + +An error object **MAY** have the following members, and **MUST** contain at +least one of: + +* `id`: a unique identifier for this particular occurrence of the problem. +* `links`: a [links object][links] that **MAY** contain the following members: + * `about`: a [link][link] that leads to further details about this + particular occurrence of the problem. When derefenced, this URI **SHOULD** + return a human-readable description of the error. + * `type`: a [link][link] that identifies the type of error that this + particular error is an instance of. This URI **SHOULD** be dereferencable to + a human-readable explanation of the general error. +* `status`: the HTTP status code applicable to this problem, expressed as a + string value. This **SHOULD** be provided. +* `code`: an application-specific error code, expressed as a string value. +* `title`: a short, human-readable summary of the problem that **SHOULD NOT** + change from occurrence to occurrence of the problem, except for purposes of + localization. +* `detail`: a human-readable explanation specific to this occurrence of the + problem. Like `title`, this field's value can be localized. +* `source`: an object containing references to the primary source of the error. + It **SHOULD** include one of the following members or be omitted: + * `pointer`: a JSON Pointer [[RFC6901](https://tools.ietf.org/html/rfc6901)] + to the value in the request document that caused the error [e.g. `"/data"` + for a primary data object, or `"/data/attributes/title"` for a specific + attribute]. This **MUST** point to a value in the request document that + exists; if it doesn't, the client **SHOULD** simply ignore the pointer. + * `parameter`: a string indicating which URI query parameter caused + the error. + * `header`: a string indicating the name of a single request header which + caused the error. +* `meta`: a [meta object][meta] containing non-standard meta-information about the + error. + +## Appendix +### Query Parameters Details +#### Parsing/Serialization +A query parameter is a name–value pair extracted from, or serialized into, a +URI's query string. + +To extract the query parameters from a URI, an implementation **MUST** run the +URI's query string, excluding the leading question mark, through the +[`application/x-www-form-urlencoded` parsing algorithm](https://url.spec.whatwg.org/#urlencoded-parsing), +with one exception: JSON:API allows the specification that defines a query +parameter's usage to provide its own rules for parsing the parameter's value +from the `value` bytes identified in steps 3.2 and and 3.3 of the `application/x-www-form-urlencoded` +parsing algorithm. The resulting value might not be a string. + +> Note: In general, the query string parsing built in to servers and browsers +> will match the process specified above, so most implementations do not need +> to worry about this. +> +> The `application/x-www-form-urlencoded` format is referenced because it is +> the basis for the `a=b&c=d` style that almost all query strings use today. +> +> However, `application/x-www-form-urlencoded` parsing contains the bizarre +> historical artifact that `+` characters must be treated as spaces, and it +> requires that all values be percent-decoded during parsing, which makes it +> impossible to use [RFC 3986 delimiter characters](https://tools.ietf.org/html/rfc3986#section-2.2) +> as delimiters. These issues motivate the exception that JSON:API defines above. + +Similarly, to serialize a query parameter into a URI, an implementation **MUST** +use the [the `application/x-www-form-urlencoded` serializer](https://url.spec.whatwg.org/#concept-urlencoded-serializer), +with the corresponding exception that a parameter's value — but not its name — +may be serialized differently than that algorithm requires, provided the +serialization does not interfere with the ability to parse back the resulting URI. + +#### Square Brackets in Parameter Names +With [query parameter families][query parameter family], JSON:API allows for +query parameters whose names contain square brackets (i.e., U+005B "[" and +U+005D "]"). + +According to the query parameter serialization rules above, a compliant +implementation will percent-encode these square brackets. However, some URI +producers — namely browsers — do not always encode them. Servers **SHOULD** +accept requests in which these square brackets are left unencoded in a query +parameter's name. If a server does accept these requests, it **MUST** treat the +request as equivalent to one in which the square brackets were percent-encoded. + +[semantics]: #semantics +[top level]: #document-top-level +[resource objects]: #document-resource-objects +[attributes]: #document-resource-object-attributes +[relationships]: #document-resource-object-relationships +[fields]: #document-resource-object-fields +[related resource link]: #document-resource-object-related-resource-links +[resource linkage]: #document-resource-object-linkage +[resource links]: #document-resource-object-links +[resource identifier object]: #document-resource-identifier-objects +[compound document]: #document-compound-documents +[meta]: #document-meta +[links]: #document-links +[link]: #document-links-link +[link object]: #document-links-link-object +[link relation type]: #document-links-link-relation-type +[extensions]: #extensions +[profiles]: #profiles +[error details]: #errors +[error object]: #error-objects +[error objects]: #errror-objects +[member names]: #document-member-names +[pagination]: #fetching-pagination +[query parameter family]: #query-parameters-families From 3eccc4f12653dea93a357a1d696ba020f428ce27 Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Thu, 29 Sep 2022 16:50:19 -0400 Subject: [PATCH 56/93] Add milestones to home page, move full history to /about --- about/index.md | 48 +++++++++++++++++++++++++++++++++++++++++------- index.md | 44 +++++++------------------------------------- 2 files changed, 48 insertions(+), 44 deletions(-) diff --git a/about/index.md b/about/index.md index 5d667d5f3..80d0e5a11 100644 --- a/about/index.md +++ b/about/index.md @@ -27,13 +27,6 @@ The following emeritus editors are no longer active: - [Steve Klabnik](https://twitter.com/steveklabnik) - [Ethan Resnick](https://twitter.com/ethanresnick) -## Roadmap - -### 1.1 - -* Embedding / creating multiple related resources in a single request -* Extension support - ## History JSON:API was originally drafted by [Yehuda Katz](https://twitter.com/wycats) @@ -72,3 +65,44 @@ The goals of the media type are to balance: * Ease of implementation on the client side This specification reached a stable version 1.0 on May 29, 2015. + +### Update history + +- 2022-09-30: 1.1 final released. +- 2022-08-22: 1.1 Release candidate 4 released. + - Formalized the definition of specification and implementation + [semantics](https://jsonapi.org/format/1.1/#semantics). + - Refined the definitions of + [extensions](https://jsonapi.org/format/1.1/#extensions) and + [profiles](https://jsonapi.org/format/1.1/#profiles). + - Clarified details regarding expected and allowed responses, query + parameters, and more. +- 2020-10-01: 1.1 Release candidate 3 released. + - Refined links objects. The link object `params` member was removed to + better align with other JSON link serializations. The `anchor` target + attribute was also removed. It may be restored in a future minor release. +- 2020-08-20: 1.1 Release candidate 2 released. + - [Extensions](https://jsonapi.org/format/1.1/#extensions) were added and the + scope of [profiles](https://jsonapi.org/format/1.1/#profiles) were reduced + since their introduction in RC1. + - [Links](https://github.com/json-api/json-api/pull/1348) can be represented + as [RFC 8288](https://tools.ietf.org/html/rfc8288)-style web links. + - A new [`describedby`](https://github.com/json-api/json-api/pull/1447) [links member](https://jsonapi.org/format/1.1/#document-top-level) + was added so that implementors can incorporate description documents (e.g. + [OpenAPI](https://www.openapis.org/) or [JSON Schema](https://json-schema.org/specification.html)) + directly into their APIs. + - [Local IDs](https://jsonapi.org/format/1.1/#document-resource-object-identification) + were [introduced](https://github.com/json-api/json-api/pull/1244) so that a + client can create a relationship to a resource yet-to-be created by the + same request. +- 2018-12-01: 1.1 Release candidate 1 released. + - New features include: [profiles](https://jsonapi.org/format/1.1/#profiles), ["@-Members"](https://jsonapi.org/format/1.1/#document-member-names-at-members), and [error object `type` links](https://jsonapi.org/format/1.1/#error-objects). + - There are editorial clarifications around: [query parameters](https://jsonapi.org/format/1.1/#query-parameters) (their parsing/serialization, and reserved parameter names), the appropriate status code for [specific](https://github.com/json-api/json-api/pull/1036) [responses](https://github.com/json-api/json-api/pull/1029), and the [presence of the `included` key](https://github.com/json-api/json-api/pull/1236) even when its value is an empty array. + - JSON:API switched to [recommending camelCased names](https://jsonapi.org/recommendations/#naming). +- 2015-05-29: 1.0 final released. +- 2015-05-21: 1.0 Release candidate 4 released. +- 2015-03-16: 1.0 Release candidate 3 released. +- 2015-02-18: 1.0 Release candidate 2 released. +- 2014-07-05: 1.0 Release candidate 1 released. +- 2013-07-21: Media type registration completed with the IANA. +- 2013-05-03: Initial release of the draft. diff --git a/index.md b/index.md index 3163e4545..31aa53acf 100644 --- a/index.md +++ b/index.md @@ -123,45 +123,15 @@ base JSON:API specification. These extensions are called profiles. You can [browse existing profiles](/extensions/#existing-profiles) or [create a new one](/extensions/#profile-creation). -## Update history - -- 2022-09-30: Expected final release of 1.1. -- 2022-08-22: 1.1 Release candidate 4 released. - - Formalized the definition of specification and implementation - [semantics](https://jsonapi.org/format/1.1/#semantics). - - Refined the definitions of - [extensions](https://jsonapi.org/format/1.1/#extensions) and - [profiles](https://jsonapi.org/format/1.1/#profiles). - - Clarified details regarding expected and allowed responses, query - parameters, and more. -- 2020-10-01: 1.1 Release candidate 3 released. - - Refined links objects. The link object `params` member was removed to - better align with other JSON link serializations. The `anchor` target - attribute was also removed. It may be restored in a future minor release. -- 2020-08-20: 1.1 Release candidate 2 released. - - [Extensions](https://jsonapi.org/format/1.1/#extensions) were added and the - scope of [profiles](https://jsonapi.org/format/1.1/#profiles) were reduced - since their introduction in RC1. - - [Links](https://github.com/json-api/json-api/pull/1348) can be represented - as [RFC 8288](https://tools.ietf.org/html/rfc8288)-style web links. - - A new [`describedby`](https://github.com/json-api/json-api/pull/1447) [links member](https://jsonapi.org/format/1.1/#document-top-level) - was added so that implementors can incorporate description documents (e.g. - [OpenAPI](https://www.openapis.org/) or [JSON Schema](https://json-schema.org/specification.html)) - directly into their APIs. - - [Local IDs](https://jsonapi.org/format/1.1/#document-resource-object-identification) - were [introduced](https://github.com/json-api/json-api/pull/1244) so that a - client can create a relationship to a resource yet-to-be created by the - same request. -- 2018-12-01: 1.1 Release candidate 1 released. - - New features include: [profiles](https://jsonapi.org/format/1.1/#profiles), ["@-Members"](https://jsonapi.org/format/1.1/#document-member-names-at-members), and [error object `type` links](https://jsonapi.org/format/1.1/#error-objects). - - There are editorial clarifications around: [query parameters](https://jsonapi.org/format/1.1/#query-parameters) (their parsing/serialization, and reserved parameter names), the appropriate status code for [specific](https://github.com/json-api/json-api/pull/1036) [responses](https://github.com/json-api/json-api/pull/1029), and the [presence of the `included` key](https://github.com/json-api/json-api/pull/1236) even when its value is an empty array. - - JSON:API switched to [recommending camelCased names](https://jsonapi.org/recommendations/#naming). +## Milestones + +Major milestones for this specification include: + +- 2022-09-30: 1.1 final released. - 2015-05-29: 1.0 final released. -- 2015-05-21: 1.0 Release candidate 4 released. -- 2015-03-16: 1.0 Release candidate 3 released. -- 2015-02-18: 1.0 Release candidate 2 released. -- 2014-07-05: 1.0 Release candidate 1 released. - 2013-07-21: Media type registration completed with the IANA. - 2013-05-03: Initial release of the draft. +A more thorough history is available [here](/about/#update-history). + You can subscribe to an RSS feed of individual changes [here](https://github.com/json-api/json-api/commits.atom). From c0a0d73a6c4aefb6f68454117d8e7869d453bcf5 Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Thu, 29 Sep 2022 16:56:49 -0400 Subject: [PATCH 57/93] Update /extensions to reflect 1.1 final --- extensions/index.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/extensions/index.md b/extensions/index.md index e5b524fe6..f76cea748 100644 --- a/extensions/index.md +++ b/extensions/index.md @@ -5,10 +5,6 @@ show_sidebar: true redirect_from: /profiles --- -> Note: This page describes features from [an upcoming version of the of the -> JSON:API specification](/format/1.1/) and is subject to change without -> notice. - The JSON:API specification provides a way to define new functionality not provided by the base specification using [extensions]. Additionally, it provides a means to share a particular usage of the specification among @@ -68,8 +64,8 @@ is maintained on a best-effort basis. common pagination strategy that avoids many of the pitfalls of "offset–limit" pagination. -[extensions]: /format/1.1/#extensions -[profiles]: /format/1.1/#profiles -[attributes]: /format/1.1/#document-resource-object-attributes -[pagination]: /format/1.1/#fetching-pagination +[extensions]: /format/#extensions +[profiles]: /format/#profiles +[attributes]: /format/#document-resource-object-attributes +[pagination]: /format/#fetching-pagination [editors]: /about/#editors From aecfcffd631d036b20a50073e5b9f677d90c33d2 Mon Sep 17 00:00:00 2001 From: Dan Gebhardt Date: Thu, 29 Sep 2022 17:02:43 -0400 Subject: [PATCH 58/93] Improve pitch on home page --- index.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/index.md b/index.md index 31aa53acf..5be98e33a 100644 --- a/index.md +++ b/index.md @@ -5,14 +5,13 @@ show_masthead: true --- If you've ever argued with your team about the way your JSON responses -should be formatted, JSON:API can be your anti-[bikeshedding](http://bikeshed.org) tool. +should be formatted, JSON:API can help you stop the +[bikeshedding](http://bikeshed.org) and focus on what matters: +**your application**. -By following shared conventions, you can increase productivity, -take advantage of generalized tooling, and focus on what -matters: your application. - -Clients built around JSON:API are able to take -advantage of its features around efficiently caching responses, +By following shared conventions, you can increase productivity, take advantage +of generalized tooling and best practices. Clients built around JSON:API are +able to take advantage of its features around efficiently caching responses, sometimes eliminating network requests entirely. Here's an example response from a blog that implements JSON:API: From b12ae6080179c3497b8d4c5bebbc1f0312748476 Mon Sep 17 00:00:00 2001 From: Alex H Date: Sat, 8 Oct 2022 12:05:37 +0400 Subject: [PATCH 59/93] Change link to repo Old repo will not be support in the future --- implementations/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/implementations/index.md b/implementations/index.md index b51d4d339..725a5e8e7 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -211,7 +211,7 @@ and writing of JSON:API documents. * [jsonapi-fractal](https://github.com/andersondanilo/jsonapi-fractal) JSON:API Serializer inspired by Fractal (PHP) * [ts-japi](https://github.com/jun-sheaf/ts-japi) - A zero-dependency, highly-modular, js/ts-friendly, recursible, framework-agnostic library for serializing data to the JSON:API specification. Serializes the entire specification. * [Kurier](https://github.com/kurierjs/kurier) is a TypeScript framework to create APIs following the [1.1 Spec of JSON:API](https://jsonapi.org/format/1.1/) + the [Operations proposal spec](https://github.com/json-api/json-api/blob/999e6df77b28549d6c37b163b73c8e9102400020/_format/1.1/index.md#operations). -* [nestjs-json-api](https://github.com/ringcentral/nestjs-json-api) A module for NestJS and TypeORM to implement JSON API supporting features such as, end point, query params, body params, validation and transformation response. +* [nestjs-json-api](https://github.com/klerick/nestjs-json-api) A module for NestJS and TypeORM to implement JSON API supporting features such as, end point, query params, body params, validation and transformation response. ### Ruby From 968ddffe5df2bff14ac6a2eb8a644cddcbce03f9 Mon Sep 17 00:00:00 2001 From: Andreas Eberhart <61732435+aeberhart@users.noreply.github.com> Date: Fri, 21 Oct 2022 13:21:24 +0200 Subject: [PATCH 60/93] Add Dashjoin under Server / Java --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index 725a5e8e7..ea45af95b 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -299,6 +299,7 @@ includes related resources. * [JSON:API for Spring HATEOAS](https://github.com/toedter/spring-hateoas-jsonapi) provides serialization/deserialization of the Spring HATEOAS representation models. The project also provides a builder to easily create relationships, included resource objects, pagination, and more. * [jsonapi-rvp](https://github.com/xlate/jsonapi-rvp) utilizes the platform capabilities available in the Jakarta EE environment (formerly Java EE) to expose JPA entities via JSON:API. Features include query and entity validation (using Bean Validators), pagination, use of surrogate keys as record identifiers, support for LEFT outer join conditions, and a simple JavaScript client. * [JSON:API object converter](https://github.com/MieskeB/json-api-spring-boot) converts normal Java objects to JSON:API standard with the use of annotations in the viewmodels (dtos). +* [Dashjoin Low Code Development Platform](https://github.com/dashjoin/platform) connects to relational, document, and graph databases and makes them available via JSON:API. The platform offers powerful access control mechanisms, a query editor, and graphical layout designers. ### Scala * [scala-jsonapi](https://github.com/scala-jsonapi/scala-jsonapi) A Scala library for producing JSON output (and deserializing JSON input) based on JSON:API specification. From 61e0067f7d67b67a8832db1dc406dd2f7c2002f9 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Fri, 28 Oct 2022 16:47:56 +0200 Subject: [PATCH 61/93] Remove unnecessary and potential confusing alias "relationships" (#1676) * remove-confusing-alias-for-relationships-object * backport to v1.1 --- _format/1.1/index.md | 2 +- _format/1.2/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 54a96e775..9ba32ce84 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -473,7 +473,7 @@ as attributes. Instead, [relationships] **SHOULD** be used. ##### Relationships The value of the `relationships` key **MUST** be an object (a "relationships -object"). Each member of a relationships object ("relationships") represents +object"). Each member of a relationships object represents a "relationship" from the [resource object][resource objects] in which it has been defined to other resource objects. diff --git a/_format/1.2/index.md b/_format/1.2/index.md index f647647a4..c71cef936 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -474,7 +474,7 @@ as attributes. Instead, [relationships] **SHOULD** be used. ##### Relationships The value of the `relationships` key **MUST** be an object (a "relationships -object"). Each member of a relationships object ("relationships") represents +object"). Each member of a relationships object represents a "relationship" from the [resource object][resource objects] in which it has been defined to other resource objects. From 5b3b34d97fefcd78509ec7c456f12d718e8f75d2 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Fri, 21 Apr 2023 23:36:00 +0200 Subject: [PATCH 62/93] allow relationship paths in query parameter families --- _format/1.2/index.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index c71cef936..7a7b92e57 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -2091,13 +2091,19 @@ family. A "query parameter family" is the set of all query parameters whose name starts with a "base name", followed by zero or more instances of empty square brackets -(i.e. `[]`) or square-bracketed legal [member names]. The family is referred to +(i.e. `[]`), square-bracketed legal [member names] or square-bracketed +dot-separated lists of legal member names. The family is referred to by its base name. For example, the `filter` query parameter family includes parameters named: `filter`, `filter[x]`, `filter[]`, `filter[x][]`, `filter[][]`, `filter[x][y]`, -etc. However, `filter[_]` is not a valid parameter name in the family, because -`_` is not a valid [member name][member names]. +`filter[x.y]`, etc. However, `filter[_]` is not a valid parameter name in the +family, because `_` is not a valid [member name][member names]. + +> Note: Dot separated lists of legal member names are intended to be used for +> relationship paths. E.g. this allows filtering strategies using relationship +> paths as defined for [sorting][fetching sorting] in query parameters such as +> `GET /posts?sort=author.name&filter[author.status]=active`. ### Extension-Specific Query Parameters From 3dbdc675081b30044a59d5ee1e0cfecdd6e9f2b9 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Mon, 24 Apr 2023 15:45:38 +0200 Subject: [PATCH 63/93] improve grammar per review comments --- _format/1.2/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index 7a7b92e57..4b3462858 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -2091,7 +2091,7 @@ family. A "query parameter family" is the set of all query parameters whose name starts with a "base name", followed by zero or more instances of empty square brackets -(i.e. `[]`), square-bracketed legal [member names] or square-bracketed +(i.e. `[]`), square-bracketed legal [member names], or square-bracketed dot-separated lists of legal member names. The family is referred to by its base name. @@ -2101,9 +2101,9 @@ For example, the `filter` query parameter family includes parameters named: family, because `_` is not a valid [member name][member names]. > Note: Dot separated lists of legal member names are intended to be used for -> relationship paths. E.g. this allows filtering strategies using relationship -> paths as defined for [sorting][fetching sorting] in query parameters such as -> `GET /posts?sort=author.name&filter[author.status]=active`. +> relationship paths. For example, this allows filtering strategies using +> relationship paths as defined for [sorting][fetching sorting] in query parameters +> such as `GET /posts?sort=author.name&filter[author.status]=active`. ### Extension-Specific Query Parameters From 3f581040fa7b84667f15caa66d4dc6f0414ab1bc Mon Sep 17 00:00:00 2001 From: Aleksei Nekrasov Date: Wed, 23 Aug 2023 11:50:02 +0300 Subject: [PATCH 64/93] Add FastAPI-JSONAPI to Python Server libraries --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index ea45af95b..353ca62d6 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -267,6 +267,7 @@ the moment. * [starlette-jsonapi](https://github.com/vladmunteanu/starlette-jsonapi) Microframework on top of Starlette and marshmallow-jsonapi with support for asynchronous ORMs * [kt.jsonapi](https://pypi.org/project/kt.jsonapi/) JSON:API response generation using the Zope Component Architecture. * [Flask-COMBO-JSONAPI](https://github.com/AdCombo/flask-combo-jsonapi) JSON:API flask extension for building REST APIs. +* [FastAPI-JSONAPI](https://github.com/mts-ai/FastAPI-JSONAPI) FastAPI-JSONAPI is a FastAPI extension for building REST APIs ### Go From 8275119124b4dd51b056052b641a2bb2edfe1358 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Thu, 2 Nov 2023 21:58:49 +0100 Subject: [PATCH 65/93] backport to v1.1 --- _format/1.1/index.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 9ba32ce84..673422412 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -2090,13 +2090,19 @@ family. A "query parameter family" is the set of all query parameters whose name starts with a "base name", followed by zero or more instances of empty square brackets -(i.e. `[]`) or square-bracketed legal [member names]. The family is referred to +(i.e. `[]`), square-bracketed legal [member names], or square-bracketed +dot-separated lists of legal member names. The family is referred to by its base name. For example, the `filter` query parameter family includes parameters named: `filter`, `filter[x]`, `filter[]`, `filter[x][]`, `filter[][]`, `filter[x][y]`, -etc. However, `filter[_]` is not a valid parameter name in the family, because -`_` is not a valid [member name][member names]. +`filter[x.y]`, etc. However, `filter[_]` is not a valid parameter name in the +family, because `_` is not a valid [member name][member names]. + +> Note: Dot separated lists of legal member names are intended to be used for +> relationship paths. For example, this allows filtering strategies using +> relationship paths as defined for [sorting][fetching sorting] in query parameters +> such as `GET /posts?sort=author.name&filter[author.status]=active`. ### Extension-Specific Query Parameters From ba999fdaa2e9c5e8ecae89f3543956e2286119c8 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Wed, 6 Dec 2023 15:59:42 +0800 Subject: [PATCH 66/93] allow profiles to define implementation-specific query parameters --- _format/1.2/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index 4b3462858..653d9dab0 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -143,7 +143,7 @@ The rules for profile usage are dictated by [RFC A profile **MAY** define document members and processing rules that are reserved for implementors. -A profile **MUST NOT** define any query parameters. +A profile **MUST NOT** define any query parameters except [implementation-specific query parameters](#query-parameters-custom). A profile **MUST NOT** alter or remove processing rules that have been defined by this specification or by an [extension][extensions]. However, a profile From 86a16dcfe765f429bf271276da448abc9c2f3a97 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Wed, 6 Dec 2023 16:02:07 +0800 Subject: [PATCH 67/93] backport to v1.1 --- _format/1.1/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 673422412..5271037ad 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -142,7 +142,7 @@ The rules for profile usage are dictated by [RFC A profile **MAY** define document members and processing rules that are reserved for implementors. -A profile **MUST NOT** define any query parameters. +A profile **MUST NOT** define any query parameters except [implementation-specific query parameters](#query-parameters-custom). A profile **MUST NOT** alter or remove processing rules that have been defined by this specification or by an [extension][extensions]. However, a profile From 1e455b05a011b46a25d7515b86294125dec42c9b Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Wed, 6 Dec 2023 21:48:14 +0800 Subject: [PATCH 68/93] avoid kebab-case case usage in example JSON:API specification recommends using camelCase since some time. But was still using kebab-case for resource type and in URL in one example. --- recommendations/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/recommendations/index.md b/recommendations/index.md index 32903033d..50873358c 100644 --- a/recommendations/index.md +++ b/recommendations/index.md @@ -211,17 +211,17 @@ The request **SHOULD** return a status `202 Accepted` with a link in the `Conten ```http HTTP/1.1 202 Accepted Content-Type: application/vnd.api+json -Content-Location: https://example.com/photos/queue-jobs/5234 +Content-Location: https://example.com/photos/jobs/5234 { "data": { - "type": "queue-jobs", + "type": "jobs", "id": "5234", "attributes": { "status": "Pending request, waiting other process" }, "links": { - "self": "/photos/queue-jobs/5234" + "self": "/photos/jobs/5234" } } } @@ -230,7 +230,7 @@ Content-Location: https://example.com/photos/queue-jobs/5234 To check the status of the job process, a client can send a request to the location given earlier. ```http -GET /photos/queue-jobs/5234 HTTP/1.1 +GET /photos/jobs/5234 HTTP/1.1 Accept: application/vnd.api+json ``` @@ -243,13 +243,13 @@ Retry-After: 10 { "data": { - "type": "queue-jobs", + "type": "jobs", "id": "5234", "attributes": { "status": "Pending request, waiting other process" }, "links": { - "self": "/photos/queue-jobs/5234" + "self": "/photos/jobs/5234" } } } From aa08ac1f4822be27615ae9db2ad811d968390256 Mon Sep 17 00:00:00 2001 From: Antoine Bluchet Date: Tue, 5 Dec 2023 17:54:48 +0100 Subject: [PATCH 69/93] feat: API Platform implementation --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index 353ca62d6..1fbcf07e9 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -184,6 +184,7 @@ and writing of JSON:API documents. * [pz/doctrine-rest](https://github.com/R3VoLuT1OneR/doctrine-rest) library provides basic tools for implementation of JSON:API with Doctrine 2 * [pz/jsonapi-resource](https://github.com/R3VoLuT1OneR/jsonapi-resource) Serialize PHP class object into JSON:API resource object using PHP 8.0 Attributes. * [binarcode/laravel-restify](https://github.com/binarcode/laravel-restify) The fastest way to make a powerful JSON:API compatible Rest API with Laravel [Reference Docs](https://restify.binarcode.com/). +* [API Platform](https://api-platform.com) is an API-first Framework supporting JSON:API. ### Node.js * [Fortune.js](http://fortune.js.org/) is a library that includes a [comprehensive implementation of JSON:API](https://github.com/fortunejs/fortune-json-api). From d2355b4c5ddf1cb7a69a0a1f9aa03af03d4d2f56 Mon Sep 17 00:00:00 2001 From: "LB (Ben Johnston)" Date: Wed, 27 Mar 2024 13:24:47 +1000 Subject: [PATCH 70/93] Docs - Update examples to use lates jsonapi The example output that has a declared 'jsonapi' value is not updated to use the latest 1.1 version. --- examples/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/index.md b/examples/index.md index aafcbfa77..5ede6eab7 100644 --- a/examples/index.md +++ b/examples/index.md @@ -303,7 +303,7 @@ HTTP/1.1 422 Unprocessable Entity Content-Type: application/vnd.api+json { - "jsonapi": { "version": "1.0" }, + "jsonapi": { "version": "1.1" }, "errors": [ { "code": "123", From 2f577e1891d490d6c43c7026a24e0f9742c5a687 Mon Sep 17 00:00:00 2001 From: Chris Read Date: Thu, 4 Apr 2024 00:09:01 +1000 Subject: [PATCH 71/93] Add new link for a Python implementation of JSON:API using generics complete with OpenAPI helper functions --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index 1fbcf07e9..3939939a4 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -264,6 +264,7 @@ the moment. * [Flump](https://github.com/rolepoint/flump) Database agnostic JSON:API builder which depends on Flask and Marshmallow. * [SAFRS JSON API Framework](https://github.com/thomaxxl/safrs) Flask-SQLAlchemy jsonapi implementation with auto-generated openapi (fka swagger) interface. * [pydantic-jsonapi](https://github.com/DeanWay/pydantic-jsonapi) JSON:api validation with python type hinting using [pydantic](https://pydantic-docs.helpmanual.io/) +* [pydanja](https://github.com/Centurix/pydanja) JSON:API implementation for [pydantic](https://pydantic-docs.helpmanual.io/) and [FastAPI](https://fastapi.tiangolo.com/) using generic types, complete with helpers for simplifying OpenAPI docs * [Flask-Restless-NG](https://github.com/mrevutskyi/flask-restless-ng) Builds JSON:API from SQLAlchemy models using Flask * [starlette-jsonapi](https://github.com/vladmunteanu/starlette-jsonapi) Microframework on top of Starlette and marshmallow-jsonapi with support for asynchronous ORMs * [kt.jsonapi](https://pypi.org/project/kt.jsonapi/) JSON:API response generation using the Zope Component Architecture. From e2b5e0717835e00d19eb67c9cb245601c095e1d6 Mon Sep 17 00:00:00 2001 From: Larry Gebhardt Date: Mon, 29 Apr 2024 15:43:28 -0400 Subject: [PATCH 72/93] Update CNAME --- CNAME | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CNAME b/CNAME index 7ccb154b0..3c2e2247d 100644 --- a/CNAME +++ b/CNAME @@ -1 +1 @@ -jsonapi.org +www.jsonapi.org \ No newline at end of file From 40329de64b556ed48b351473c000aee7c94d0302 Mon Sep 17 00:00:00 2001 From: Larry Gebhardt Date: Mon, 29 Apr 2024 15:44:04 -0400 Subject: [PATCH 73/93] Update CNAME --- CNAME | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CNAME b/CNAME index 3c2e2247d..f8f8a9e05 100644 --- a/CNAME +++ b/CNAME @@ -1 +1 @@ -www.jsonapi.org \ No newline at end of file +jsonapi.org \ No newline at end of file From af47518badf387775184872680b7f6fb4763ecda Mon Sep 17 00:00:00 2001 From: VGirol Date: Sun, 19 May 2024 23:48:32 +0200 Subject: [PATCH 74/93] Update JSON Schema to be v1.0 compliant (#1600) * Update JSON Schema to be v1.0 compliant * Update schema to be more reusable * Add schema to validate a request that update a resource or a relationship * Change naming convention and folder structure to be more consistent * Enhance reusability * Lint test files * Fix typo * Update JSON Schema to be v1.0 compliant * Update schema to be more reusable * Add schema to validate a request that update a resource or a relationship * Change naming convention and folder structure to be more consistent * Change all title to more neutral text. Add meta member to all test files with informations about errors present in the document. * Add script to valide JSON schema against all test files and update schemas based on the results of the script. * Add documentation on how to run the tests for the JSON Schemas * Update validation script of JSON Schema so that validation is also done using files from previous versions * script linting * Revert "script linting" This reverts commit 8ce88f1bb22ab12281e03b480c0273fb89c51167. * Script linting * Enhance script output * Enhance readability * Add -f and -v options to test script * Fix typo * Add test-schema to CI * Fix typo in bash command to run script * Change trigger for the "Schema validation test" workflow * Allow for parallel relationships in JSON Schema * Bump ajv version * Update to latest version of json-schema * Remove node_modules --- .github/workflows/node.yml | 27 + .gitignore | 4 + CONTRIBUTING.md | 25 + _schemas/1.0/schema.json | 587 ++++++++++++++++++ _schemas/1.0/schema_create_resource.json | 49 ++ _schemas/1.0/schema_update_relationship.json | 23 + _schemas/1.0/schema_update_resource.json | 49 ++ ...source_identifier_must_have_id_member.json | 15 + .../update/valid/patch_relationship.json | 12 + .../invalid/data_is_not_resource_object.json | 22 + .../create/invalid/no_data_member.json | 12 + ...tionship_with_bad_resource_identifier.json | 25 + .../relationship_with_forbidden_name.json | 26 + ...lationship_with_not_allowed_character.json | 26 + .../relationship_without_data_member.json | 25 + .../resource/create/valid/post_resource.json | 8 + ...ost_resource_with_client_generated_id.json | 9 + .../post_resource_with_relationships.json | 28 + .../post_resource_without_attributes.json | 5 + .../invalid/data_must_have_id_member.json | 18 + .../resource/update/valid/patch_resource.json | 9 + .../patch_resource_with_relationships.json | 29 + .../patch_resource_without_attributes.json | 6 + .../attributes_member_not_valid.json | 20 + .../attributes_must_not_have_id_member.json | 20 + .../attributes_must_not_have_type_member.json | 20 + .../data/data_can_not_be_a_string.json | 13 + .../data/data_can_not_be_array_of_string.json | 15 + .../errors/error_must_be_an_object.json | 15 + .../errors/errors_must_be_an_array.json | 16 + .../invalid/errors/invalid_error_objects.json | 137 ++++ .../included_member_must_be_collection.json | 39 ++ .../included/included_resource_not_valid.json | 41 ++ .../included/resource_included_twice.json | 50 ++ .../tests/response/invalid/invalid_multi.json | 26 + .../jsonapi_with_not_allowed_members.json | 16 + .../invalid/jsonapi/meta_is_not_valid.json | 18 + .../invalid/jsonapi/not_an_object.json | 22 + .../jsonapi/version_is_not_a_string.json | 15 + .../links/link_href_must_be_a_string.json | 17 + .../links/link_must_be_string_or_object.json | 15 + .../invalid/links/link_must_be_valid_uri.json | 15 + .../links/links_must_be_an_object.json | 13 + .../invalid/meta/meta_must_be_an_object.json | 14 + .../meta/meta_must_have_valid_members.json | 13 + .../relationships/link_name_not_allowed.json | 32 + .../relationships/linkage_must_be_object.json | 24 + .../relationships/links_not_valid.json | 28 + .../invalid/relationships/meta_not_valid.json | 30 + .../relationship_must_not_be_empty.json | 22 + .../relationship_must_not_be_named_id.json | 27 + .../relationship_must_not_be_named_type.json | 27 + ...p_must_not_have_additional_properties.json | 28 + .../relationship_name_is_not_valid.json | 27 + .../relationships_is_not_an_object.json | 20 + .../to_many_linkage_not_valid.json | 30 + .../to_one_linkage_not_valid.json | 28 + .../invalid/resource/id_must_be_string.json | 19 + .../resource/relationship_named_id.json | 27 + .../resource/relationship_named_type.json | 27 + .../resource_must_have_id_member.json | 18 + .../resource_must_have_type_member.json | 18 + .../invalid/resource/type_must_be_string.json | 19 + .../resource/type_must_not_be_empty.json | 19 + .../resource/type_value_is_not_valid.json | 19 + .../resource/with_additional_properties.json | 20 + .../resource_included_twice.json | 32 + .../id_must_be_string.json | 16 + .../resource_must_have_id_member.json | 18 + .../resource_must_have_type_member.json | 18 + .../type_must_be_string.json | 16 + .../type_must_not_be_empty.json | 16 + .../type_value_is_not_valid.json | 16 + .../with_additional_properties.json | 17 + .../data_and_errors_must_not_coexist.json | 22 + .../top-level/included_must_not_be_alone.json | 21 + .../invalid/top-level/invalid_root.json | 3 + ...s_must_not_have_additional_properties.json | 15 + .../no_mandatory_top_level_members.json | 18 + .../top-level/with_additional_properties.json | 13 + .../valid/with_failure/errors_and_meta.json | 31 + .../with_failure/only_errors/one_error.json | 16 + .../response/valid/with_success/complete.json | 87 +++ .../data_and_included/single_resource.json | 93 +++ .../valid/with_success/data_and_meta.json | 12 + .../valid/with_success/data_is_null.json | 3 + .../with_success/linkage/empty_to_many.json | 14 + .../with_success/linkage/empty_to_one.json | 14 + .../valid/with_success/linkage/to_many.json | 34 + .../valid/with_success/linkage/to_one.json | 20 + .../only_data/empty_resource_collection.json | 3 + .../only_data/no_resource_null.json | 3 + .../only_data/parallel_relationships.json | 33 + .../only_data/resource_collection.json | 28 + .../resource_identifier_collection.json | 16 + .../only_data/single_resource.json | 16 + .../only_data/single_resource_identifier.json | 6 + ...single_resource_with_empty_attributes.json | 7 + .../valid/with_success/only_meta.json | 9 + .../with_success/only_meta/empty_meta.json | 3 + .../only_meta/meta_with_members.json | 9 + _schemas/scripts/validator.js | 317 ++++++++++ package-lock.json | 117 ++++ package.json | 11 + schema | 397 ------------ 105 files changed, 3261 insertions(+), 397 deletions(-) create mode 100644 .github/workflows/node.yml create mode 100644 _schemas/1.0/schema.json create mode 100644 _schemas/1.0/schema_create_resource.json create mode 100644 _schemas/1.0/schema_update_relationship.json create mode 100644 _schemas/1.0/schema_update_resource.json create mode 100644 _schemas/1.0/tests/request/relationship/update/invalid/resource_identifier_must_have_id_member.json create mode 100644 _schemas/1.0/tests/request/relationship/update/valid/patch_relationship.json create mode 100644 _schemas/1.0/tests/request/resource/create/invalid/data_is_not_resource_object.json create mode 100644 _schemas/1.0/tests/request/resource/create/invalid/no_data_member.json create mode 100644 _schemas/1.0/tests/request/resource/create/invalid/relationship_with_bad_resource_identifier.json create mode 100644 _schemas/1.0/tests/request/resource/create/invalid/relationship_with_forbidden_name.json create mode 100644 _schemas/1.0/tests/request/resource/create/invalid/relationship_with_not_allowed_character.json create mode 100644 _schemas/1.0/tests/request/resource/create/invalid/relationship_without_data_member.json create mode 100644 _schemas/1.0/tests/request/resource/create/valid/post_resource.json create mode 100644 _schemas/1.0/tests/request/resource/create/valid/post_resource_with_client_generated_id.json create mode 100644 _schemas/1.0/tests/request/resource/create/valid/post_resource_with_relationships.json create mode 100644 _schemas/1.0/tests/request/resource/create/valid/post_resource_without_attributes.json create mode 100644 _schemas/1.0/tests/request/resource/update/invalid/data_must_have_id_member.json create mode 100644 _schemas/1.0/tests/request/resource/update/valid/patch_resource.json create mode 100644 _schemas/1.0/tests/request/resource/update/valid/patch_resource_with_relationships.json create mode 100644 _schemas/1.0/tests/request/resource/update/valid/patch_resource_without_attributes.json create mode 100644 _schemas/1.0/tests/response/invalid/attributes/attributes_member_not_valid.json create mode 100644 _schemas/1.0/tests/response/invalid/attributes/attributes_must_not_have_id_member.json create mode 100644 _schemas/1.0/tests/response/invalid/attributes/attributes_must_not_have_type_member.json create mode 100644 _schemas/1.0/tests/response/invalid/data/data_can_not_be_a_string.json create mode 100644 _schemas/1.0/tests/response/invalid/data/data_can_not_be_array_of_string.json create mode 100644 _schemas/1.0/tests/response/invalid/errors/error_must_be_an_object.json create mode 100644 _schemas/1.0/tests/response/invalid/errors/errors_must_be_an_array.json create mode 100644 _schemas/1.0/tests/response/invalid/errors/invalid_error_objects.json create mode 100644 _schemas/1.0/tests/response/invalid/included/included_member_must_be_collection.json create mode 100644 _schemas/1.0/tests/response/invalid/included/included_resource_not_valid.json create mode 100644 _schemas/1.0/tests/response/invalid/included/resource_included_twice.json create mode 100644 _schemas/1.0/tests/response/invalid/invalid_multi.json create mode 100644 _schemas/1.0/tests/response/invalid/jsonapi/jsonapi_with_not_allowed_members.json create mode 100644 _schemas/1.0/tests/response/invalid/jsonapi/meta_is_not_valid.json create mode 100644 _schemas/1.0/tests/response/invalid/jsonapi/not_an_object.json create mode 100644 _schemas/1.0/tests/response/invalid/jsonapi/version_is_not_a_string.json create mode 100644 _schemas/1.0/tests/response/invalid/links/link_href_must_be_a_string.json create mode 100644 _schemas/1.0/tests/response/invalid/links/link_must_be_string_or_object.json create mode 100644 _schemas/1.0/tests/response/invalid/links/link_must_be_valid_uri.json create mode 100644 _schemas/1.0/tests/response/invalid/links/links_must_be_an_object.json create mode 100644 _schemas/1.0/tests/response/invalid/meta/meta_must_be_an_object.json create mode 100644 _schemas/1.0/tests/response/invalid/meta/meta_must_have_valid_members.json create mode 100644 _schemas/1.0/tests/response/invalid/relationships/link_name_not_allowed.json create mode 100644 _schemas/1.0/tests/response/invalid/relationships/linkage_must_be_object.json create mode 100644 _schemas/1.0/tests/response/invalid/relationships/links_not_valid.json create mode 100644 _schemas/1.0/tests/response/invalid/relationships/meta_not_valid.json create mode 100644 _schemas/1.0/tests/response/invalid/relationships/relationship_must_not_be_empty.json create mode 100644 _schemas/1.0/tests/response/invalid/relationships/relationship_must_not_be_named_id.json create mode 100644 _schemas/1.0/tests/response/invalid/relationships/relationship_must_not_be_named_type.json create mode 100644 _schemas/1.0/tests/response/invalid/relationships/relationship_must_not_have_additional_properties.json create mode 100644 _schemas/1.0/tests/response/invalid/relationships/relationship_name_is_not_valid.json create mode 100644 _schemas/1.0/tests/response/invalid/relationships/relationships_is_not_an_object.json create mode 100644 _schemas/1.0/tests/response/invalid/relationships/to_many_linkage_not_valid.json create mode 100644 _schemas/1.0/tests/response/invalid/relationships/to_one_linkage_not_valid.json create mode 100644 _schemas/1.0/tests/response/invalid/resource/id_must_be_string.json create mode 100644 _schemas/1.0/tests/response/invalid/resource/relationship_named_id.json create mode 100644 _schemas/1.0/tests/response/invalid/resource/relationship_named_type.json create mode 100644 _schemas/1.0/tests/response/invalid/resource/resource_must_have_id_member.json create mode 100644 _schemas/1.0/tests/response/invalid/resource/resource_must_have_type_member.json create mode 100644 _schemas/1.0/tests/response/invalid/resource/type_must_be_string.json create mode 100644 _schemas/1.0/tests/response/invalid/resource/type_must_not_be_empty.json create mode 100644 _schemas/1.0/tests/response/invalid/resource/type_value_is_not_valid.json create mode 100644 _schemas/1.0/tests/response/invalid/resource/with_additional_properties.json create mode 100644 _schemas/1.0/tests/response/invalid/resource_collection/resource_included_twice.json create mode 100644 _schemas/1.0/tests/response/invalid/resource_identifier/id_must_be_string.json create mode 100644 _schemas/1.0/tests/response/invalid/resource_identifier/resource_must_have_id_member.json create mode 100644 _schemas/1.0/tests/response/invalid/resource_identifier/resource_must_have_type_member.json create mode 100644 _schemas/1.0/tests/response/invalid/resource_identifier/type_must_be_string.json create mode 100644 _schemas/1.0/tests/response/invalid/resource_identifier/type_must_not_be_empty.json create mode 100644 _schemas/1.0/tests/response/invalid/resource_identifier/type_value_is_not_valid.json create mode 100644 _schemas/1.0/tests/response/invalid/resource_identifier/with_additional_properties.json create mode 100644 _schemas/1.0/tests/response/invalid/top-level/data_and_errors_must_not_coexist.json create mode 100644 _schemas/1.0/tests/response/invalid/top-level/included_must_not_be_alone.json create mode 100644 _schemas/1.0/tests/response/invalid/top-level/invalid_root.json create mode 100644 _schemas/1.0/tests/response/invalid/top-level/links_must_not_have_additional_properties.json create mode 100644 _schemas/1.0/tests/response/invalid/top-level/no_mandatory_top_level_members.json create mode 100644 _schemas/1.0/tests/response/invalid/top-level/with_additional_properties.json create mode 100644 _schemas/1.0/tests/response/valid/with_failure/errors_and_meta.json create mode 100644 _schemas/1.0/tests/response/valid/with_failure/only_errors/one_error.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/complete.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/data_and_included/single_resource.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/data_and_meta.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/data_is_null.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/linkage/empty_to_many.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/linkage/empty_to_one.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/linkage/to_many.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/linkage/to_one.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/only_data/empty_resource_collection.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/only_data/no_resource_null.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/only_data/parallel_relationships.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/only_data/resource_collection.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/only_data/resource_identifier_collection.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/only_data/single_resource.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/only_data/single_resource_identifier.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/only_data/single_resource_with_empty_attributes.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/only_meta.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/only_meta/empty_meta.json create mode 100644 _schemas/1.0/tests/response/valid/with_success/only_meta/meta_with_members.json create mode 100644 _schemas/scripts/validator.js create mode 100644 package-lock.json create mode 100644 package.json delete mode 100644 schema diff --git a/.github/workflows/node.yml b/.github/workflows/node.yml new file mode 100644 index 000000000..21917fc17 --- /dev/null +++ b/.github/workflows/node.yml @@ -0,0 +1,27 @@ +name: Schema validation tests + +on: + push: + branches: [ gh-pages, schema-1.0 ] + pull_request: + branches: [ gh-pages ] + +jobs: + build: + + runs-on: ubuntu-latest + + strategy: + matrix: + node-version: [16.x] + + steps: + - uses: actions/checkout@v4 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node-version }} + - name: Install dependencies + run: npm ci + - name: Test schemas + run: npm run test-schema \ No newline at end of file diff --git a/.gitignore b/.gitignore index e369c5255..7ae6b8609 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,7 @@ Gemfile.lock /bin /b .rbx + +# Ignore the node_modules directory + +/node_modules diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 551f1251d..4fdfb8d1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,3 +17,28 @@ place. Ideas for new extensions and questions about how to correctly implement or consume an API that adheres to the JSON:API specification belong here. [about]: http://jsonapi.org/about + +## JSON Schema +If you would like to update the JSON schemas, you must first install the node.js dependencies : + +` +npm install +` + +Then you can run the schema validator by running one of the following commands : + +` +node ./_schemas/scripts/validator.js +` + +or + +` +npm run test-schema +` + +This script validates all test files against all available versions of the specification. +Some options can be used : +- `--verbose` : allows more verbose output. +- `-f relative-path` : the relative path of the only file to test. For example : `npm run test-schema -- -f _schemas/1.0/response/valid/with_success/complete.json` +- `-v version` : the version of the specification to use to test the files. For example : `npm run test-schema -- -v 1.0` diff --git a/_schemas/1.0/schema.json b/_schemas/1.0/schema.json new file mode 100644 index 000000000..c7a0679eb --- /dev/null +++ b/_schemas/1.0/schema.json @@ -0,0 +1,587 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://jsonapi.org/schemas/spec/v1.0/draft", + "$comment": "The $id URI should be modified before releasing. This URI does not need to be network addressable. It is an ID only.", + "title": "JSON:API Schema", + "description": "This schema only validates RESPONSES from a request. Validating request payloads requires slightly different constraints.", + "allOf": [ + { + "$ref": "#/definitions/requiredTopLevelMembers" + }, + { + "$ref": "#/definitions/oneOfDataOrErrors" + } + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/data" + }, + "errors": { + "$ref": "#/definitions/errors" + }, + "included": { + "$ref": "#/definitions/included" + }, + "jsonapi": { + "$ref": "#/definitions/jsonapi" + }, + "links": { + "description": "Link members related to the primary data.", + "$ref": "#/definitions/topLevelLinks" + }, + "meta": { + "$ref": "#/definitions/meta" + } + }, + "dependencies": { + "included": ["data"] + }, + "additionalProperties": false, + "definitions": { + "attributes": { + "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", + "type": "object", + "propertyNames": { + "$ref": "#/definitions/memberName" + }, + "patternProperties": { + "": true + }, + "not": { + "$comment": "This is what the specification requires, but it seems bad. https://github.com/json-api/json-api/issues/1553", + "anyOf": [ + { + "required": [ + "type" + ] + }, + { + "required": [ + "id" + ] + } + ] + }, + "additionalProperties": false + }, + "data": { + "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", + "oneOf": [ + { + "$ref": "#/definitions/resource" + }, + { + "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", + "$ref": "#/definitions/resourceCollection" + }, + { + "description": "null if the request is one that might correspond to a single resource, but doesn't currently.", + "type": "null" + } + ] + }, + "empty": { + "description": "Describes an empty to-one relationship.", + "type": "null" + }, + "error": { + "type": "object", + "properties": { + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "type": "string", + "$comment": "The spec doesn't specify that this MUST be a string, so this could be changed to additionally allow numbers" + }, + "links": { + "$ref": "#/definitions/errorLinks" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "type": "string" + }, + "code": { + "description": "An application-specific error code, expressed as a string value.", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "type": "string" + }, + "source": { + "type": "object", + "properties": { + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].", + "type": "string", + "pattern": "^(?:\\/(?:[^~/]|~0|~1)*)*$" + }, + "parameter": { + "description": "A string indicating which query parameter caused the error.", + "type": "string" + } + } + }, + "meta": { + "$ref": "#/definitions/meta" + } + }, + "additionalProperties": false + }, + "errorLinks": { + "description": "The error links object **MAY** contain the following members: about.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/links" + } + ], + "properties": { + "about": { + "description": "A link that leads to further details about this particular occurrence of the problem.", + "$ref": "#/definitions/link" + } + }, + "additionalProperties": false + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/error" + }, + "uniqueItems": true + }, + "included": { + "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", + "type": "array", + "items": { + "$ref": "#/definitions/resource" + }, + "uniqueItems": true + }, + "jsonapi": { + "description": "An object describing the server's implementation", + "type": "object", + "properties": { + "version": { + "type": "string" + }, + "meta": { + "$ref": "#/definitions/meta" + } + }, + "additionalProperties": false + }, + "linkObject": { + "type": "object", + "properties": { + "href": { + "$ref": "#/definitions/linkUrl" + }, + "meta": { + "$ref": "#/definitions/meta" + } + } + }, + "linkUrl": { + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri", + "$comment": "URI regex as per https://tools.ietf.org/html/rfc3986#appendix-B", + "pattern": "^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?" + }, + "link": { + "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", + "oneOf": [ + { + "$ref": "#/definitions/linkUrl" + }, + { + "$ref": "#/definitions/linkObject" + } + ] + }, + "linkage": { + "description": "Resource linkage in a compound document allows a client to link together all of the included resource objects without having to GET any URLs via links.", + "oneOf": [ + { + "$ref": "#/definitions/relationshipToOne" + }, + { + "$ref": "#/definitions/relationshipToMany" + } + ] + }, + "links": { + "type": "object" + }, + "memberName": { + "description": "Member name may contain any valid JSON value.", + "type": "string", + "pattern": "^[a-zA-Z0-9]{1}(?:[-\\w]*[a-zA-Z0-9])?$" + }, + "meta": { + "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", + "type": "object", + "propertyNames": { + "$ref": "#/definitions/memberName" + }, + "patternProperties": { + "": true + }, + "additionalProperties": false + }, + "oneOfDataOrErrors": { + "type": "object", + "dependencies": { + "data": { + "not": { + "required": [ + "errors" + ] + } + } + } + }, + "pagination": { + "type": "object", + "properties": { + "first": { + "description": "The first page of data", + "oneOf": [ + { + "$ref": "#/definitions/link" + }, + { + "type": "null" + } + ] + }, + "last": { + "description": "The last page of data", + "oneOf": [ + { + "$ref": "#/definitions/link" + }, + { + "type": "null" + } + ] + }, + "prev": { + "description": "The previous page of data", + "oneOf": [ + { + "$ref": "#/definitions/link" + }, + { + "type": "null" + } + ] + }, + "next": { + "description": "The next page of data", + "oneOf": [ + { + "$ref": "#/definitions/link" + }, + { + "type": "null" + } + ] + } + } + }, + "relationship": { + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/relationshipLinks" + }, + "data": { + "$ref": "#/definitions/linkage" + }, + "meta": { + "$ref": "#/definitions/meta" + } + }, + "anyOf": [ + { + "required": ["data"] + }, + { + "required": ["meta"] + }, + { + "required": ["links"] + } + ], + "additionalProperties": false + }, + "relationshipFromRequest": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/linkage" + }, + "meta": { + "$ref": "#/definitions/meta" + } + }, + "required": [ + "data" + ], + "additionalProperties": false + }, + "relationshipLinks": { + "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/links" + }, + { + "description": "Pagination links", + "$ref": "#/definitions/pagination" + } + ], + "properties": { + "self": { + "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", + "$ref": "#/definitions/link" + }, + "related": { + "$ref": "#/definitions/link" + }, + "first": true, + "last": true, + "next": true, + "prev": true + }, + "additionalProperties": false + }, + "relationshipToMany": { + "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", + "type": "array", + "items": { + "$ref": "#/definitions/resourceIdentifier" + } + }, + "relationshipToOne": { + "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.", + "oneOf": [ + { + "$ref": "#/definitions/empty" + }, + { + "$ref": "#/definitions/resourceIdentifier" + } + ] + }, + "relationships": { + "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", + "type": "object", + "propertyNames": { + "$ref": "#/definitions/memberName" + }, + "patternProperties": { + "": { + "$ref": "#/definitions/relationship" + } + }, + "allOf": [ + { + "$ref": "#/definitions/relationshipsForbiddenMemberName" + } + ], + "additionalProperties": false + }, + "relationshipsFromRequest": { + "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", + "type": "object", + "propertyNames": { + "$ref": "#/definitions/memberName" + }, + "patternProperties": { + "": { + "$ref": "#/definitions/relationshipFromRequest" + } + }, + "allOf": [ + { + "$ref": "#/definitions/relationshipsForbiddenMemberName" + } + ], + "additionalProperties": false + }, + "relationshipsForbiddenMemberName": { + "not": { + "anyOf": [ + { + "type": "object", + "required": [ + "type" + ] + }, + { + "type": "object", + "required": [ + "id" + ] + } + ] + } + }, + "requiredTopLevelMembers": { + "anyOf": [ + { + "type": "object", + "required": [ + "meta" + ] + }, + { + "type": "object", + "required": [ + "data" + ] + }, + { + "type": "object", + "required": [ + "errors" + ] + } + ] + }, + "resource": { + "description": "\"Resource objects\" appear in a JSON:API document to represent resources.", + "$comment": "The id member is not required when the resource object originates at the client and represents a new resource to be created on the server.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/resourceIdentification" + } + ], + "properties": { + "id": true, + "type": true, + "attributes": { + "$ref": "#/definitions/attributes" + }, + "links": { + "$ref": "#/definitions/resourceLinks" + }, + "meta": { + "$ref": "#/definitions/meta" + }, + "relationships": { + "$ref": "#/definitions/relationships" + } + }, + "additionalProperties": false + }, + "resourceCollection": { + "description": "An array of resource objects.", + "type": "array", + "items": { + "$ref": "#/definitions/resource" + }, + "uniqueItems": true + }, + "resourceIdentification": { + "allOf": [ + { + "$ref": "#/definitions/resourceIdentificationNew" + }, + { + "type": "object", + "required": [ + "type", + "id" + ] + } + ] + }, + "resourceIdentificationNew": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "pattern": "^[a-zA-Z0-9]{1}(?:[-\\w]*[a-zA-Z0-9])?$" + }, + "id": { + "type": "string" + } + } + }, + "resourceIdentifier": { + "description": "The \"type\" and \"id\" to non-empty members.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/resourceIdentification" + } + ], + "properties": { + "id": true, + "type": true, + "meta": { + "$ref": "#/definitions/meta" + } + }, + "additionalProperties": false + }, + "resourceLinks": { + "description": "The top-level links object **MAY** contain the following members: self, related, pagination links.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/links" + } + ], + "properties": { + "self": { + "description": "", + "$ref": "#/definitions/link" + } + }, + "additionalProperties": false + }, + "topLevelLinks": { + "description": "The top-level links object **MAY** contain the following members: self, related, pagination links.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/links" + }, + { + "description": "Pagination links for the primary data.", + "$ref": "#/definitions/pagination" + } + ], + "properties": { + "self": { + "description": "The link that generated the current response document.", + "$ref": "#/definitions/link" + }, + "related": { + "description": "A related resource link when the primary data represents a resource relationship.", + "$ref": "#/definitions/link" + }, + "first": true, + "last": true, + "next": true, + "prev": true + }, + "additionalProperties": false + } + } +} diff --git a/_schemas/1.0/schema_create_resource.json b/_schemas/1.0/schema_create_resource.json new file mode 100644 index 000000000..012651689 --- /dev/null +++ b/_schemas/1.0/schema_create_resource.json @@ -0,0 +1,49 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://jsonapi.org/schemas/spec/v1.0/draft/create/resource", + "$comment": "The $id URI should be modified before releasing. This URI does not need to be network addressable. It is an ID only.", + "title": "JSON:API Schema for POST request", + "description": "This schema only validates a request for POSTing a new resource.", + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/definitions/resource" + }, + "jsonapi": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/jsonapi" + }, + "meta": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/meta" + } + }, + "additionalProperties": false, + "definitions": { + "resource": { + "description": "\"Resource objects\" appear in a JSON:API document to represent resources.", + "$comment": "The id member is not required when the resource object originates at the client and represents a new resource to be created on the server.", + "type": "object", + "allOf": [ + { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/resourceIdentificationNew" + } + ], + "properties": { + "id": true, + "type": true, + "attributes": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/attributes" + }, + "meta": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/meta" + }, + "relationships": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/relationshipsFromRequest" + } + }, + "additionalProperties": false + } + } +} diff --git a/_schemas/1.0/schema_update_relationship.json b/_schemas/1.0/schema_update_relationship.json new file mode 100644 index 000000000..2fbcdba64 --- /dev/null +++ b/_schemas/1.0/schema_update_relationship.json @@ -0,0 +1,23 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://jsonapi.org/schemas/spec/v1.0/draft/update/relationship", + "$comment": "The $id URI should be modified before releasing. This URI does not need to be network addressable. It is an ID only.", + "title": "JSON:API Schema for POST request", + "description": "This schema only validates a request for PATCHing a resource's relationship.", + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/linkage" + }, + "jsonapi": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/jsonapi" + }, + "meta": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/meta" + } + }, + "additionalProperties": false +} diff --git a/_schemas/1.0/schema_update_resource.json b/_schemas/1.0/schema_update_resource.json new file mode 100644 index 000000000..d83a37e5a --- /dev/null +++ b/_schemas/1.0/schema_update_resource.json @@ -0,0 +1,49 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://jsonapi.org/schemas/spec/v1.0/draft/update/resource", + "$comment": "The $id URI should be modified before releasing. This URI does not need to be network addressable. It is an ID only.", + "title": "JSON:API Schema for POST request", + "description": "This schema only validates a request for PATCHing a resource.", + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/definitions/resource" + }, + "jsonapi": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/jsonapi" + }, + "meta": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/meta" + } + }, + "additionalProperties": false, + "definitions": { + "resource": { + "description": "\"Resource objects\" appear in a JSON:API document to represent resources.", + "$comment": "The id member is not required when the resource object originates at the client and represents a new resource to be created on the server.", + "type": "object", + "allOf": [ + { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/resourceIdentification" + } + ], + "properties": { + "id": true, + "type": true, + "attributes": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/attributes" + }, + "meta": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/meta" + }, + "relationships": { + "$ref": "https://jsonapi.org/schemas/spec/v1.0/draft#/definitions/relationshipsFromRequest" + } + }, + "additionalProperties": false + } + } +} diff --git a/_schemas/1.0/tests/request/relationship/update/invalid/resource_identifier_must_have_id_member.json b/_schemas/1.0/tests/request/relationship/update/invalid/resource_identifier_must_have_id_member.json new file mode 100644 index 000000000..b1853ade7 --- /dev/null +++ b/_schemas/1.0/tests/request/relationship/update/invalid/resource_identifier_must_have_id_member.json @@ -0,0 +1,15 @@ +{ + "data": { + "type": "tag" + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource object **MUST** contain at least the following top-level members: id, type.", + "source": { + "pointer": "/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/request/relationship/update/valid/patch_relationship.json b/_schemas/1.0/tests/request/relationship/update/valid/patch_relationship.json new file mode 100644 index 000000000..0947edab2 --- /dev/null +++ b/_schemas/1.0/tests/request/relationship/update/valid/patch_relationship.json @@ -0,0 +1,12 @@ +{ + "data": [ + { + "type": "tag", + "id": "2" + }, + { + "type": "tag", + "id": "13" + } + ] +} diff --git a/_schemas/1.0/tests/request/resource/create/invalid/data_is_not_resource_object.json b/_schemas/1.0/tests/request/resource/create/invalid/data_is_not_resource_object.json new file mode 100644 index 000000000..3e9814515 --- /dev/null +++ b/_schemas/1.0/tests/request/resource/create/invalid/data_is_not_resource_object.json @@ -0,0 +1,22 @@ +{ + "data": [ + { + "type": "article", + "id": "1" + }, + { + "type": "article", + "id": "2" + } + ], + "meta": { + "errors-present-in-document": [ + { + "detail": "Primary data **MUST** be a single resource object.", + "source": { + "pointer": "/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/request/resource/create/invalid/no_data_member.json b/_schemas/1.0/tests/request/resource/create/invalid/no_data_member.json new file mode 100644 index 000000000..ba1685f68 --- /dev/null +++ b/_schemas/1.0/tests/request/resource/create/invalid/no_data_member.json @@ -0,0 +1,12 @@ +{ + "meta": { + "errors-present-in-document": [ + { + "detail": "The request **MUST** include a top-level member named \"data\".", + "source": { + "pointer": "/" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/request/resource/create/invalid/relationship_with_bad_resource_identifier.json b/_schemas/1.0/tests/request/resource/create/invalid/relationship_with_bad_resource_identifier.json new file mode 100644 index 000000000..a7dd08fec --- /dev/null +++ b/_schemas/1.0/tests/request/resource/create/invalid/relationship_with_bad_resource_identifier.json @@ -0,0 +1,25 @@ +{ + "data": { + "type": "article", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "toOne": { + "data": { + "type": "wrong" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource object **MUST** contain at least the following top-level members: id, type.", + "source": { + "pointer": "/data/relationships/toOne/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/request/resource/create/invalid/relationship_with_forbidden_name.json b/_schemas/1.0/tests/request/resource/create/invalid/relationship_with_forbidden_name.json new file mode 100644 index 000000000..4ca3b0bce --- /dev/null +++ b/_schemas/1.0/tests/request/resource/create/invalid/relationship_with_forbidden_name.json @@ -0,0 +1,26 @@ +{ + "data": { + "type": "article", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "type": { + "data": { + "type": "status", + "id": "140" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A relationship **CAN NOT** be named type or id.", + "source": { + "pointer": "/data/relationships" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/request/resource/create/invalid/relationship_with_not_allowed_character.json b/_schemas/1.0/tests/request/resource/create/invalid/relationship_with_not_allowed_character.json new file mode 100644 index 000000000..73f740963 --- /dev/null +++ b/_schemas/1.0/tests/request/resource/create/invalid/relationship_with_not_allowed_character.json @@ -0,0 +1,26 @@ +{ + "data": { + "type": "article", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "not-allowed+": { + "data": { + "type": "status", + "id": "140" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Member names **MUST** contain only allowed characters.", + "source": { + "pointer": "/data/relationships" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/request/resource/create/invalid/relationship_without_data_member.json b/_schemas/1.0/tests/request/resource/create/invalid/relationship_without_data_member.json new file mode 100644 index 000000000..68c93c621 --- /dev/null +++ b/_schemas/1.0/tests/request/resource/create/invalid/relationship_without_data_member.json @@ -0,0 +1,25 @@ +{ + "data": { + "type": "article", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "toOne": { + "meta": { + "bad": "wrong" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A \"relationship object\" **MUST** have a data member.", + "source": { + "pointer": "/data/relationships/toOne" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/request/resource/create/valid/post_resource.json b/_schemas/1.0/tests/request/resource/create/valid/post_resource.json new file mode 100644 index 000000000..dfacd1761 --- /dev/null +++ b/_schemas/1.0/tests/request/resource/create/valid/post_resource.json @@ -0,0 +1,8 @@ +{ + "data": { + "type": "article", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + } + } +} diff --git a/_schemas/1.0/tests/request/resource/create/valid/post_resource_with_client_generated_id.json b/_schemas/1.0/tests/request/resource/create/valid/post_resource_with_client_generated_id.json new file mode 100644 index 000000000..80e731357 --- /dev/null +++ b/_schemas/1.0/tests/request/resource/create/valid/post_resource_with_client_generated_id.json @@ -0,0 +1,9 @@ +{ + "data": { + "type": "article", + "id": "c0f10761-a507-4a9f-920a-9d967bcec335", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + } + } +} diff --git a/_schemas/1.0/tests/request/resource/create/valid/post_resource_with_relationships.json b/_schemas/1.0/tests/request/resource/create/valid/post_resource_with_relationships.json new file mode 100644 index 000000000..9c9a5e816 --- /dev/null +++ b/_schemas/1.0/tests/request/resource/create/valid/post_resource_with_relationships.json @@ -0,0 +1,28 @@ +{ + "data": { + "type": "article", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "toOne": { + "data": { + "type": "status", + "id": "140" + } + }, + "toMany": { + "data": [ + { + "type": "tag", + "id": "15" + }, + { + "type": "tag", + "id": "32" + } + ] + } + } + } +} diff --git a/_schemas/1.0/tests/request/resource/create/valid/post_resource_without_attributes.json b/_schemas/1.0/tests/request/resource/create/valid/post_resource_without_attributes.json new file mode 100644 index 000000000..8d7e4e1be --- /dev/null +++ b/_schemas/1.0/tests/request/resource/create/valid/post_resource_without_attributes.json @@ -0,0 +1,5 @@ +{ + "data": { + "type": "article" + } +} diff --git a/_schemas/1.0/tests/request/resource/update/invalid/data_must_have_id_member.json b/_schemas/1.0/tests/request/resource/update/invalid/data_must_have_id_member.json new file mode 100644 index 000000000..37c5513dc --- /dev/null +++ b/_schemas/1.0/tests/request/resource/update/invalid/data_must_have_id_member.json @@ -0,0 +1,18 @@ +{ + "data": { + "type": "article", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource object **MUST** contain at least the following top-level members: id, type.", + "source": { + "pointer": "/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/request/resource/update/valid/patch_resource.json b/_schemas/1.0/tests/request/resource/update/valid/patch_resource.json new file mode 100644 index 000000000..bc9f043b2 --- /dev/null +++ b/_schemas/1.0/tests/request/resource/update/valid/patch_resource.json @@ -0,0 +1,9 @@ +{ + "data": { + "type": "article", + "id": "2", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + } + } +} diff --git a/_schemas/1.0/tests/request/resource/update/valid/patch_resource_with_relationships.json b/_schemas/1.0/tests/request/resource/update/valid/patch_resource_with_relationships.json new file mode 100644 index 000000000..5769713ec --- /dev/null +++ b/_schemas/1.0/tests/request/resource/update/valid/patch_resource_with_relationships.json @@ -0,0 +1,29 @@ +{ + "data": { + "type": "article", + "id": "2", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "toOne": { + "data": { + "type": "status", + "id": "140" + } + }, + "toMany": { + "data": [ + { + "type": "tag", + "id": "15" + }, + { + "type": "tag", + "id": "32" + } + ] + } + } + } +} diff --git a/_schemas/1.0/tests/request/resource/update/valid/patch_resource_without_attributes.json b/_schemas/1.0/tests/request/resource/update/valid/patch_resource_without_attributes.json new file mode 100644 index 000000000..2c36d919b --- /dev/null +++ b/_schemas/1.0/tests/request/resource/update/valid/patch_resource_without_attributes.json @@ -0,0 +1,6 @@ +{ + "data": { + "type": "article", + "id": "2" + } +} diff --git a/_schemas/1.0/tests/response/invalid/attributes/attributes_member_not_valid.json b/_schemas/1.0/tests/response/invalid/attributes/attributes_member_not_valid.json new file mode 100644 index 000000000..95bf69898 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/attributes/attributes_member_not_valid.json @@ -0,0 +1,20 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "key+": "bad", + "something": "wrong" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Member names **MUST** contain only allowed characters.", + "source": { + "pointer": "/data/attributes" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/attributes/attributes_must_not_have_id_member.json b/_schemas/1.0/tests/response/invalid/attributes/attributes_must_not_have_id_member.json new file mode 100644 index 000000000..2d11c8116 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/attributes/attributes_must_not_have_id_member.json @@ -0,0 +1,20 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "id": "bad", + "something": "wrong" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource **CAN NOT** have an attribute named type or id.", + "source": { + "pointer": "/data/attributes" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/attributes/attributes_must_not_have_type_member.json b/_schemas/1.0/tests/response/invalid/attributes/attributes_must_not_have_type_member.json new file mode 100644 index 000000000..3807c51a2 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/attributes/attributes_must_not_have_type_member.json @@ -0,0 +1,20 @@ +{ + "data": { + "type": "article", + "id": "2", + "attributes": { + "type": "bad", + "something": "wrong" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource **CAN NOT** have an attribute named type or id.", + "source": { + "pointer": "/data/attributes" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/data/data_can_not_be_a_string.json b/_schemas/1.0/tests/response/invalid/data/data_can_not_be_a_string.json new file mode 100644 index 000000000..fbf9a4dfa --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/data/data_can_not_be_a_string.json @@ -0,0 +1,13 @@ +{ + "data": "not valid", + "meta": { + "errors-present-in-document": [ + { + "detail": "Primary data **MUST** be either: 1) a single resource object, a single resource identifier object, or null, for requests that target single resource 2) an array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections", + "source": { + "pointer": "/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/data/data_can_not_be_array_of_string.json b/_schemas/1.0/tests/response/invalid/data/data_can_not_be_array_of_string.json new file mode 100644 index 000000000..995eba76a --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/data/data_can_not_be_array_of_string.json @@ -0,0 +1,15 @@ +{ + "data": [ + "not valid" + ], + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource **MUST** be an object.", + "source": { + "pointer": "/data/0" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/errors/error_must_be_an_object.json b/_schemas/1.0/tests/response/invalid/errors/error_must_be_an_object.json new file mode 100644 index 000000000..97d00a423 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/errors/error_must_be_an_object.json @@ -0,0 +1,15 @@ +{ + "errors": [ + "wrong" + ], + "meta": { + "errors-present-in-document": [ + { + "detail": "An error object **MUST** be an object.", + "source": { + "pointer": "/errors/0" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/errors/errors_must_be_an_array.json b/_schemas/1.0/tests/response/invalid/errors/errors_must_be_an_array.json new file mode 100644 index 000000000..b3de3808d --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/errors/errors_must_be_an_array.json @@ -0,0 +1,16 @@ +{ + "errors": { + "status": "400", + "title": "Oh no!" + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "The top-level errors member **MUST** be an array of error objects.", + "source": { + "pointer": "/errors" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/errors/invalid_error_objects.json b/_schemas/1.0/tests/response/invalid/errors/invalid_error_objects.json new file mode 100644 index 000000000..bc8142e26 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/errors/invalid_error_objects.json @@ -0,0 +1,137 @@ +{ + "errors": [ + "wrong : An error object **MUST** be an object.", + { + "id": 0, + "status": "400", + "code": "4", + "title": "Oh no!", + "detail": "The id member **MUST** be a string.", + "source": { + "pointer": "/id" + } + }, + { + "id": "0", + "status": 400, + "code": "4", + "title": "Oh no!", + "detail": "The status member **MUST** be a string.", + "source": { + "pointer": "/status" + } + }, + { + "id": "0", + "status": "400", + "code": 4, + "title": "Oh no!", + "detail": "The code member **MUST** be a string.", + "source": { + "pointer": "/code" + } + }, + { + "id": "0", + "status": "400", + "code": "4", + "title": { + "wrong": "Oh no!" + }, + "detail": "The title member **MUST** be a string.", + "source": { + "pointer": "/title" + } + }, + { + "id": "0", + "status": "400", + "code": "4", + "title": "Oh no!", + "detail": { + "wrong": "The detail member **MUST** be a string." + }, + "source": { + "pointer": "/details" + } + }, + { + "id": "0", + "status": "400", + "code": "4", + "title": "Oh no!", + "detail": "The pointer member **MUST** be a string.", + "source": { + "pointer": { + "wrong": "/source/pointer" + } + } + }, + { + "id": "0", + "status": "400", + "code": "4", + "title": "Oh no!", + "detail": "The pointer member **MUST** be a valid JSON Pointer [RFC6901].", + "source": { + "pointer": "bad pattern for /source/pointer" + } + }, + { + "id": "0", + "status": "400", + "code": "4", + "title": "Oh no!", + "detail": "The parameter member **MUST** be a string.", + "source": { + "pointer": "/source/parameter", + "parameter": { + "wrong": "not a string" + } + } + }, + { + "id": "0", + "status": "400", + "code": "4", + "title": "Oh no!", + "detail": "Unless otherwise noted, objects defined by this specification **MUST NOT** contain any additional members (here, \"wrong\").", + "source": { + "pointer": "/wrong" + }, + "wrong": "not allowed" + }, + { + "id": "0", + "status": "400", + "code": "4", + "title": "Oh no!", + "detail": "Unless otherwise noted, objects defined by this specification **MUST NOT** contain any additional members (here, \"wrong\").", + "source": { + "pointer": "/links/wrong" + }, + "links": { + "wrong": "http://www.example.com/not/allowed" + } + }, + { + "id": "0", + "status": "400", + "code": "4", + "title": "Oh no!", + "detail": "The source member **MUST** be an object.", + "source": "not an object" + }, + { + "id": "0", + "status": "400", + "code": "4", + "title": "Oh no!", + "detail": "The value of each meta member **MUST** be an object (a \"meta object\").", + "source": { + "pointer": "/meta" + }, + "meta": "not an object" + } + ] +} diff --git a/_schemas/1.0/tests/response/invalid/included/included_member_must_be_collection.json b/_schemas/1.0/tests/response/invalid/included/included_member_must_be_collection.json new file mode 100644 index 000000000..727ec0fbd --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/included/included_member_must_be_collection.json @@ -0,0 +1,39 @@ +{ + "links": { + "self": "http://example.com/articles/1" + }, + "data": { + "type": "articles", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "data": { + "type": "people", + "id": "9" + } + } + } + }, + "included": { + "type": "people", + "id": "9", + "attributes": { + "firstName": "Dan", + "lastName": "Gebhardt", + "twitter": "dgeb" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "The top-level included member **MUST** be an array of resource objects.", + "source": { + "pointer": "/included" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/included/included_resource_not_valid.json b/_schemas/1.0/tests/response/invalid/included/included_resource_not_valid.json new file mode 100644 index 000000000..6add9e58b --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/included/included_resource_not_valid.json @@ -0,0 +1,41 @@ +{ + "links": { + "self": "http://example.com/articles/1" + }, + "data": { + "type": "articles", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "data": { + "type": "people", + "id": "9" + } + } + } + }, + "included": [ + { + "type": "people", + "id": 9, + "attributes": { + "firstName": "Dan", + "lastName": "Gebhardt", + "twitter": "dgeb" + } + } + ], + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource's id member **MUST** be a string.", + "source": { + "pointer": "/included/0/id" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/included/resource_included_twice.json b/_schemas/1.0/tests/response/invalid/included/resource_included_twice.json new file mode 100644 index 000000000..855b9f9ab --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/included/resource_included_twice.json @@ -0,0 +1,50 @@ +{ + "links": { + "self": "http://example.com/articles/1" + }, + "data": { + "type": "articles", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "data": { + "type": "people", + "id": "9" + } + } + } + }, + "included": [ + { + "type": "people", + "id": "9", + "attributes": { + "firstName": "Dan", + "lastName": "Gebhardt", + "twitter": "dgeb" + } + }, + { + "type": "people", + "id": "9", + "attributes": { + "firstName": "Dan", + "lastName": "Gebhardt", + "twitter": "dgeb" + } + } + ], + "meta": { + "errors-present-in-document": [ + { + "detail": "A compound document **MUST NOT** include more than one resource object for each \"type\" and \"id\" pair.", + "source": { + "pointer": "/included" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/invalid_multi.json b/_schemas/1.0/tests/response/invalid/invalid_multi.json new file mode 100644 index 000000000..1320f6299 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/invalid_multi.json @@ -0,0 +1,26 @@ +{ + "data": { + "type": "article", + "id": 1 + }, + "jsonapi": { + "version": "1.0", + "oups": "error" + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource's id member **MUST** be a string.", + "source": { + "pointer": "/data/id" + } + }, + { + "detail": "Unless otherwise noted, objects defined by this specification **MUST NOT** contain any additional members (here, \"oups\").", + "source": { + "pointer": "/jsonapi" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/jsonapi/jsonapi_with_not_allowed_members.json b/_schemas/1.0/tests/response/invalid/jsonapi/jsonapi_with_not_allowed_members.json new file mode 100644 index 000000000..7973e0ff5 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/jsonapi/jsonapi_with_not_allowed_members.json @@ -0,0 +1,16 @@ +{ + "jsonapi": { + "version": "1.0", + "oups": "error" + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Unless otherwise noted, objects defined by this specification **MUST NOT** contain any additional members (here, \"oups\").", + "source": { + "pointer": "/jsonapi" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/jsonapi/meta_is_not_valid.json b/_schemas/1.0/tests/response/invalid/jsonapi/meta_is_not_valid.json new file mode 100644 index 000000000..d32d1ac31 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/jsonapi/meta_is_not_valid.json @@ -0,0 +1,18 @@ +{ + "jsonapi": { + "version": "1.0", + "meta": { + "key+": "wrong" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Member names **MUST** contain only allowed characters.", + "source": { + "pointer": "/jsonapi/meta" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/jsonapi/not_an_object.json b/_schemas/1.0/tests/response/invalid/jsonapi/not_an_object.json new file mode 100644 index 000000000..b4a8325d0 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/jsonapi/not_an_object.json @@ -0,0 +1,22 @@ +{ + "jsonapi": [ + { + "version": "1.0" + }, + { + "meta": { + "key+": "wrong" + } + } + ], + "meta": { + "errors-present-in-document": [ + { + "detail": "If present, the value of the jsonapi member **MUST** be an object (a \"jsonapi object\").", + "source": { + "pointer": "/jsonapi" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/jsonapi/version_is_not_a_string.json b/_schemas/1.0/tests/response/invalid/jsonapi/version_is_not_a_string.json new file mode 100644 index 000000000..d1384bee1 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/jsonapi/version_is_not_a_string.json @@ -0,0 +1,15 @@ +{ + "jsonapi": { + "version": 1 + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "If present, the value of the version member **MUST** be a string.", + "source": { + "pointer": "/jsonapi/version" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/links/link_href_must_be_a_string.json b/_schemas/1.0/tests/response/invalid/links/link_href_must_be_a_string.json new file mode 100644 index 000000000..3d100fd99 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/links/link_href_must_be_a_string.json @@ -0,0 +1,17 @@ +{ + "links": { + "self": { + "href": 400 + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "The href member **MUST** be a string containing the link’s URL.", + "source": { + "pointer": "/links/self/href" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/links/link_must_be_string_or_object.json b/_schemas/1.0/tests/response/invalid/links/link_must_be_string_or_object.json new file mode 100644 index 000000000..74de60312 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/links/link_must_be_string_or_object.json @@ -0,0 +1,15 @@ +{ + "links": { + "self": 400 + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", + "source": { + "pointer": "/links/self" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/links/link_must_be_valid_uri.json b/_schemas/1.0/tests/response/invalid/links/link_must_be_valid_uri.json new file mode 100644 index 000000000..c7ded4838 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/links/link_must_be_valid_uri.json @@ -0,0 +1,15 @@ +{ + "links": { + "self": "wrong" + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "If represented as a string, a link **MUST** be a string containing a valid URI.", + "source": { + "pointer": "/links/self" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/links/links_must_be_an_object.json b/_schemas/1.0/tests/response/invalid/links/links_must_be_an_object.json new file mode 100644 index 000000000..4e053c3fc --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/links/links_must_be_an_object.json @@ -0,0 +1,13 @@ +{ + "links": "not valid", + "meta": { + "errors-present-in-document": [ + { + "detail": "The value of each links member **MUST** be an object (a \"links object\").", + "source": { + "pointer": "/links" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/meta/meta_must_be_an_object.json b/_schemas/1.0/tests/response/invalid/meta/meta_must_be_an_object.json new file mode 100644 index 000000000..d73e2969c --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/meta/meta_must_be_an_object.json @@ -0,0 +1,14 @@ +{ + "meta": [ + { + "errors-present-in-document": [ + { + "detail": "The value of each meta member **MUST** be an object (a \"meta object\").", + "source": { + "pointer": "/meta" + } + } + ] + } + ] +} diff --git a/_schemas/1.0/tests/response/invalid/meta/meta_must_have_valid_members.json b/_schemas/1.0/tests/response/invalid/meta/meta_must_have_valid_members.json new file mode 100644 index 000000000..b6793f63f --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/meta/meta_must_have_valid_members.json @@ -0,0 +1,13 @@ +{ + "meta": { + "key+": "not valid", + "errors-present-in-document": [ + { + "detail": "Member names **MUST** contain only allowed characters.", + "source": { + "pointer": "/meta" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/relationships/link_name_not_allowed.json b/_schemas/1.0/tests/response/invalid/relationships/link_name_not_allowed.json new file mode 100644 index 000000000..4c7807d41 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/relationships/link_name_not_allowed.json @@ -0,0 +1,32 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "links": { + "self": "http://example.com/articles/1/relationships/author", + "related": "http://example.com/articles/1/author", + "wrong": "http://www.example.com/not/allowed" + }, + "data": { + "type": "people", + "id": "9" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Unless otherwise noted, objects defined by this specification **MUST NOT** contain any additional members (here, \"wrong\").", + "source": { + "pointer": "/data/relationships/author/links" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/relationships/linkage_must_be_object.json b/_schemas/1.0/tests/response/invalid/relationships/linkage_must_be_object.json new file mode 100644 index 000000000..2b5a6a639 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/relationships/linkage_must_be_object.json @@ -0,0 +1,24 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "data": "too bad" + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Resource linkage **MUST** be represented as one of the following: null for empty to-one relationships, an empty array ([]) for empty to-many relationships, a single resource identifier object for non-empty to-one relationships, an array of resource identifier objects for non-empty to-many relationships.", + "source": { + "pointer": "/data/relationships/author/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/relationships/links_not_valid.json b/_schemas/1.0/tests/response/invalid/relationships/links_not_valid.json new file mode 100644 index 000000000..fb19780d6 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/relationships/links_not_valid.json @@ -0,0 +1,28 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "links": "not valid", + "data": { + "type": "people", + "id": "9" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "The value of each links member **MUST** be an object (a \"links object\").", + "source": { + "pointer": "/data/relationships/author/links" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/relationships/meta_not_valid.json b/_schemas/1.0/tests/response/invalid/relationships/meta_not_valid.json new file mode 100644 index 000000000..692eb741a --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/relationships/meta_not_valid.json @@ -0,0 +1,30 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "data": { + "type": "people", + "id": "9" + }, + "meta": { + "no+": "not valid" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Member names **MUST** contain only allowed characters.", + "source": { + "pointer": "/data/relationships/author/meta" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/relationships/relationship_must_not_be_empty.json b/_schemas/1.0/tests/response/invalid/relationships/relationship_must_not_be_empty.json new file mode 100644 index 000000000..c57005956 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/relationships/relationship_must_not_be_empty.json @@ -0,0 +1,22 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": {} + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A \"relationship object\" **MUST** contain at least one of the following: links, data, meta.", + "source": { + "pointer": "/data/relationships/author" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/relationships/relationship_must_not_be_named_id.json b/_schemas/1.0/tests/response/invalid/relationships/relationship_must_not_be_named_id.json new file mode 100644 index 000000000..c9eaca7e1 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/relationships/relationship_must_not_be_named_id.json @@ -0,0 +1,27 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "id": { + "data": { + "type": "people", + "id": "9" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A relationship **CAN NOT** be named type or id.", + "source": { + "pointer": "/data/relationships" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/relationships/relationship_must_not_be_named_type.json b/_schemas/1.0/tests/response/invalid/relationships/relationship_must_not_be_named_type.json new file mode 100644 index 000000000..3a6bf8bf1 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/relationships/relationship_must_not_be_named_type.json @@ -0,0 +1,27 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "type": { + "data": { + "type": "people", + "id": "9" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A relationship **CAN NOT** be named type or id.", + "source": { + "pointer": "/data/relationships" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/relationships/relationship_must_not_have_additional_properties.json b/_schemas/1.0/tests/response/invalid/relationships/relationship_must_not_have_additional_properties.json new file mode 100644 index 000000000..98d6a6046 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/relationships/relationship_must_not_have_additional_properties.json @@ -0,0 +1,28 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "data": { + "type": "people", + "id": "9" + }, + "wrong": "not allowed" + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Unless otherwise noted, objects defined by this specification **MUST NOT** contain any additional members (here, \"wrong\").", + "source": { + "pointer": "/data/relationships/author" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/relationships/relationship_name_is_not_valid.json b/_schemas/1.0/tests/response/invalid/relationships/relationship_name_is_not_valid.json new file mode 100644 index 000000000..b01702701 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/relationships/relationship_name_is_not_valid.json @@ -0,0 +1,27 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "notValid+": { + "data": { + "type": "people", + "id": "9" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Member names **MUST** contain only allowed characters.", + "source": { + "pointer": "/data/relationships" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/relationships/relationships_is_not_an_object.json b/_schemas/1.0/tests/response/invalid/relationships/relationships_is_not_an_object.json new file mode 100644 index 000000000..6f93278bb --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/relationships/relationships_is_not_an_object.json @@ -0,0 +1,20 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": "very bad" + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "The value of the relationships key **MUST** be an object (a \"relationships object\").", + "source": { + "pointer": "/data/relationships" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/relationships/to_many_linkage_not_valid.json b/_schemas/1.0/tests/response/invalid/relationships/to_many_linkage_not_valid.json new file mode 100644 index 000000000..5a8e4ff1f --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/relationships/to_many_linkage_not_valid.json @@ -0,0 +1,30 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "data": [ + { + "type": "people", + "id": "9", + "bad": "not valid" + } + ] + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Unless otherwise noted, objects defined by this specification **MUST NOT** contain any additional members (here, \"bad\").", + "source": { + "pointer": "/data/relationships/author/data/0" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/relationships/to_one_linkage_not_valid.json b/_schemas/1.0/tests/response/invalid/relationships/to_one_linkage_not_valid.json new file mode 100644 index 000000000..40974bb5e --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/relationships/to_one_linkage_not_valid.json @@ -0,0 +1,28 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "data": { + "type": "people", + "id": "9", + "bad": "not valid" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Unless otherwise noted, objects defined by this specification **MUST NOT** contain any additional members (here, \"bad\").", + "source": { + "pointer": "/data/relationships/author/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource/id_must_be_string.json b/_schemas/1.0/tests/response/invalid/resource/id_must_be_string.json new file mode 100644 index 000000000..6ac2a3cb6 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource/id_must_be_string.json @@ -0,0 +1,19 @@ +{ + "data": { + "type": "article", + "id": 2, + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource's id member **MUST** be a string.", + "source": { + "pointer": "/data/id" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource/relationship_named_id.json b/_schemas/1.0/tests/response/invalid/resource/relationship_named_id.json new file mode 100644 index 000000000..785ace67b --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource/relationship_named_id.json @@ -0,0 +1,27 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "id": { + "data": { + "type": "wrong", + "id": "9" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A relationship **CAN NOT** be named type or id.", + "source": { + "pointer": "/data/relationships" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource/relationship_named_type.json b/_schemas/1.0/tests/response/invalid/resource/relationship_named_type.json new file mode 100644 index 000000000..eb0594ed2 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource/relationship_named_type.json @@ -0,0 +1,27 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "type": { + "data": { + "type": "wrong", + "id": "9" + } + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A relationship **CAN NOT** be named type or id.", + "source": { + "pointer": "/data/relationships" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource/resource_must_have_id_member.json b/_schemas/1.0/tests/response/invalid/resource/resource_must_have_id_member.json new file mode 100644 index 000000000..37c5513dc --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource/resource_must_have_id_member.json @@ -0,0 +1,18 @@ +{ + "data": { + "type": "article", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource object **MUST** contain at least the following top-level members: id, type.", + "source": { + "pointer": "/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource/resource_must_have_type_member.json b/_schemas/1.0/tests/response/invalid/resource/resource_must_have_type_member.json new file mode 100644 index 000000000..e932801c2 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource/resource_must_have_type_member.json @@ -0,0 +1,18 @@ +{ + "data": { + "id": "3", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource object **MUST** contain at least the following top-level members: id, type.", + "source": { + "pointer": "/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource/type_must_be_string.json b/_schemas/1.0/tests/response/invalid/resource/type_must_be_string.json new file mode 100644 index 000000000..2cd27e12f --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource/type_must_be_string.json @@ -0,0 +1,19 @@ +{ + "data": { + "type": 400, + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource's type member **MUST** be a string.", + "source": { + "pointer": "/data/type" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource/type_must_not_be_empty.json b/_schemas/1.0/tests/response/invalid/resource/type_must_not_be_empty.json new file mode 100644 index 000000000..73c2f3759 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource/type_must_not_be_empty.json @@ -0,0 +1,19 @@ +{ + "data": { + "type": "", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "The values of type members **MUST** contain only allowed characters.", + "source": { + "pointer": "/data/type" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource/type_value_is_not_valid.json b/_schemas/1.0/tests/response/invalid/resource/type_value_is_not_valid.json new file mode 100644 index 000000000..57ed09e41 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource/type_value_is_not_valid.json @@ -0,0 +1,19 @@ +{ + "data": { + "type": "test+1", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "The values of type members **MUST** contain only allowed characters.", + "source": { + "pointer": "/data/type" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource/with_additional_properties.json b/_schemas/1.0/tests/response/invalid/resource/with_additional_properties.json new file mode 100644 index 000000000..989491efd --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource/with_additional_properties.json @@ -0,0 +1,20 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "bad": "property" + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Unless otherwise noted, objects defined by this specification **MUST NOT** contain any additional members (here, \"bad\").", + "source": { + "pointer": "/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource_collection/resource_included_twice.json b/_schemas/1.0/tests/response/invalid/resource_collection/resource_included_twice.json new file mode 100644 index 000000000..00e42fb4c --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource_collection/resource_included_twice.json @@ -0,0 +1,32 @@ +{ + "data": [ + { + "type": "people", + "id": "9", + "attributes": { + "firstName": "Dan", + "lastName": "Gebhardt", + "twitter": "dgeb" + } + }, + { + "type": "people", + "id": "9", + "attributes": { + "firstName": "Dan", + "lastName": "Gebhardt", + "twitter": "dgeb" + } + } + ], + "meta": { + "errors-present-in-document": [ + { + "detail": "A document **MUST NOT** include more than one resource object for each \"type\" and \"id\" pair.", + "source": { + "pointer": "/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource_identifier/id_must_be_string.json b/_schemas/1.0/tests/response/invalid/resource_identifier/id_must_be_string.json new file mode 100644 index 000000000..a6fc5f18f --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource_identifier/id_must_be_string.json @@ -0,0 +1,16 @@ +{ + "data": { + "type": "article", + "id": 2 + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource's id member **MUST** be a string.", + "source": { + "pointer": "/data/id" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource_identifier/resource_must_have_id_member.json b/_schemas/1.0/tests/response/invalid/resource_identifier/resource_must_have_id_member.json new file mode 100644 index 000000000..64a47dc47 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource_identifier/resource_must_have_id_member.json @@ -0,0 +1,18 @@ +{ + "data": { + "type": "article", + "meta": { + "something": "wrong" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource object **MUST** contain at least the following top-level members: id, type.", + "source": { + "pointer": "/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource_identifier/resource_must_have_type_member.json b/_schemas/1.0/tests/response/invalid/resource_identifier/resource_must_have_type_member.json new file mode 100644 index 000000000..5765ada04 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource_identifier/resource_must_have_type_member.json @@ -0,0 +1,18 @@ +{ + "data": { + "id": "3", + "meta": { + "something": "bad" + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource object **MUST** contain at least the following top-level members: id, type.", + "source": { + "pointer": "/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource_identifier/type_must_be_string.json b/_schemas/1.0/tests/response/invalid/resource_identifier/type_must_be_string.json new file mode 100644 index 000000000..158404b04 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource_identifier/type_must_be_string.json @@ -0,0 +1,16 @@ +{ + "data": { + "type": 400, + "id": "1" + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A resource's type member **MUST** be a string.", + "source": { + "pointer": "/data/type" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource_identifier/type_must_not_be_empty.json b/_schemas/1.0/tests/response/invalid/resource_identifier/type_must_not_be_empty.json new file mode 100644 index 000000000..e979f2c9e --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource_identifier/type_must_not_be_empty.json @@ -0,0 +1,16 @@ +{ + "data": { + "type": "", + "id": "1" + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "The values of type members **MUST** contain only allowed characters.", + "source": { + "pointer": "/data/type" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource_identifier/type_value_is_not_valid.json b/_schemas/1.0/tests/response/invalid/resource_identifier/type_value_is_not_valid.json new file mode 100644 index 000000000..9640a3417 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource_identifier/type_value_is_not_valid.json @@ -0,0 +1,16 @@ +{ + "data": { + "type": "test+1", + "id": "1" + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "The values of type members **MUST** contain only allowed characters.", + "source": { + "pointer": "/data/type" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/resource_identifier/with_additional_properties.json b/_schemas/1.0/tests/response/invalid/resource_identifier/with_additional_properties.json new file mode 100644 index 000000000..f0936810d --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/resource_identifier/with_additional_properties.json @@ -0,0 +1,17 @@ +{ + "data": { + "type": "article", + "id": "1", + "bad": "property" + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Unless otherwise noted, objects defined by this specification **MUST NOT** contain any additional members (here, \"bad\").", + "source": { + "pointer": "/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/top-level/data_and_errors_must_not_coexist.json b/_schemas/1.0/tests/response/invalid/top-level/data_and_errors_must_not_coexist.json new file mode 100644 index 000000000..e52351d77 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/top-level/data_and_errors_must_not_coexist.json @@ -0,0 +1,22 @@ +{ + "data": { + "type": "article", + "id": "1" + }, + "errors": [ + { + "status": "400", + "title": "Oh no!" + } + ], + "meta": { + "errors-present-in-document": [ + { + "detail": "The members data and errors **MUST NOT** coexist in the same document.", + "source": { + "pointer": "/" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/top-level/included_must_not_be_alone.json b/_schemas/1.0/tests/response/invalid/top-level/included_must_not_be_alone.json new file mode 100644 index 000000000..6b43bc63a --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/top-level/included_must_not_be_alone.json @@ -0,0 +1,21 @@ +{ + "included": [ + { + "type": "article", + "id": "1", + "attributes": { + "somthing": "to know" + } + } + ], + "meta": { + "errors-present-in-document": [ + { + "detail": "If a document does not contain a top-level data key, the included member **MUST NOT** be present either.", + "source": { + "pointer": "/" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/top-level/invalid_root.json b/_schemas/1.0/tests/response/invalid/top-level/invalid_root.json new file mode 100644 index 000000000..4a89e049f --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/top-level/invalid_root.json @@ -0,0 +1,3 @@ +{ + "not": "valid" +} diff --git a/_schemas/1.0/tests/response/invalid/top-level/links_must_not_have_additional_properties.json b/_schemas/1.0/tests/response/invalid/top-level/links_must_not_have_additional_properties.json new file mode 100644 index 000000000..9fa017d38 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/top-level/links_must_not_have_additional_properties.json @@ -0,0 +1,15 @@ +{ + "links": { + "wrong": "http://www.example.com" + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "Unless otherwise noted, objects defined by this specification **MUST NOT** contain any additional members (here, \"wrong\").", + "source": { + "pointer": "/links" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/invalid/top-level/no_mandatory_top_level_members.json b/_schemas/1.0/tests/response/invalid/top-level/no_mandatory_top_level_members.json new file mode 100644 index 000000000..881304d88 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/top-level/no_mandatory_top_level_members.json @@ -0,0 +1,18 @@ +{ + "jsonapi": { + "version": "1.0", + "meta": { + "errors-present-in-document": [ + { + "detail": "A document **MUST** contain at least one of the following top-level members: data, errors or meta.", + "source": { + "pointer": "/" + } + } + ] + } + }, + "links": { + "self": "http://www.example.com" + } +} diff --git a/_schemas/1.0/tests/response/invalid/top-level/with_additional_properties.json b/_schemas/1.0/tests/response/invalid/top-level/with_additional_properties.json new file mode 100644 index 000000000..b86a860b8 --- /dev/null +++ b/_schemas/1.0/tests/response/invalid/top-level/with_additional_properties.json @@ -0,0 +1,13 @@ +{ + "something": "wrong", + "meta": { + "errors-present-in-document": [ + { + "detail": "Unless otherwise noted, objects defined by this specification **MUST NOT** contain any additional members (here, \"something\").", + "source": { + "pointer": "/" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/valid/with_failure/errors_and_meta.json b/_schemas/1.0/tests/response/valid/with_failure/errors_and_meta.json new file mode 100644 index 000000000..21c49764c --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_failure/errors_and_meta.json @@ -0,0 +1,31 @@ +{ + "errors": [ + { + "id": "1", + "links": { + "about": "http://www.example.com/errors/1" + }, + "status": "400", + "code": "0x002", + "title": "human-readable summary of the problem", + "source": { + "pointer": "/data/id" + } + }, + { + "id": "2", + "links": { + "about": "http://www.example.com/errors/2" + }, + "status": "400", + "code": "0x008", + "title": "human-readable summary of the problem", + "source": { + "parameter": "include" + } + } + ], + "meta": { + "anything": "valid" + } +} diff --git a/_schemas/1.0/tests/response/valid/with_failure/only_errors/one_error.json b/_schemas/1.0/tests/response/valid/with_failure/only_errors/one_error.json new file mode 100644 index 000000000..652c38b80 --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_failure/only_errors/one_error.json @@ -0,0 +1,16 @@ +{ + "errors": [ + { + "id": "1", + "links": { + "about": "http://www.example.com/errors/1" + }, + "status": "400", + "code": "0x002", + "title": "human-readable summary of the problem", + "source": { + "pointer": "/data/id" + } + } + ] +} diff --git a/_schemas/1.0/tests/response/valid/with_success/complete.json b/_schemas/1.0/tests/response/valid/with_success/complete.json new file mode 100644 index 000000000..a4fcb6017 --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/complete.json @@ -0,0 +1,87 @@ +{ + "links": { + "self": "http://example.com/articles", + "first": "http://example.com/articles?page%5Bnumber%5D=1&page%5Bsize%5D=25", + "last": { + "href": "http://example.com/articles?page%5Bnumber%5D=1&page%5Bsize%5D=25" + }, + "next": null, + "prev": null + }, + "data": [ + { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "links": { + "self": "http://example.com/articles/1/relationships/author", + "related": "http://example.com/articles/1/author" + }, + "data": { + "type": "people", + "id": "9" + }, + "meta": { + "nothing": "else" + } + } + }, + "links": { + "self": "http://example.com/articles/1" + }, + "meta": { + "resource": "is valid" + } + }, + { + "type": "article", + "id": "2", + "attributes": { + "title": "second" + }, + "relationships": { + "author": { + "links": { + "self": "http://example.com/articles/2/relationships/author", + "related": "http://example.com/articles/2/author" + }, + "data": { + "type": "people", + "id": "9" + }, + "meta": { + "nothing": "else" + } + } + }, + "links": { + "self": "http://example.com/articles/2" + }, + "meta": { + "resource": "is valid" + } + } + ], + "meta": { + "something": "ok" + }, + "jsonapi": { + "version": "1.0", + "meta": { + "anything": "right" + } + }, + "included": [ + { + "type": "people", + "id": "9", + "attributes": { + "name": "John Doe" + } + } + ] +} diff --git a/_schemas/1.0/tests/response/valid/with_success/data_and_included/single_resource.json b/_schemas/1.0/tests/response/valid/with_success/data_and_included/single_resource.json new file mode 100644 index 000000000..8e74285eb --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/data_and_included/single_resource.json @@ -0,0 +1,93 @@ +{ + "links": { + "self": "http://example.com/articles/1" + }, + "data": { + "type": "articles", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "links": { + "self": "http://example.com/articles/1/relationships/author", + "related": "http://example.com/articles/1/author" + }, + "data": { + "type": "people", + "id": "9" + } + }, + "comments": { + "links": { + "self": "http://example.com/articles/1/relationships/comments", + "related": "http://example.com/articles/1/comments" + }, + "data": [ + { + "type": "comments", + "id": "5" + }, + { + "type": "comments", + "id": "12" + } + ] + } + }, + "links": { + "self": "http://example.com/articles/1" + } + }, + "included": [ + { + "type": "people", + "id": "9", + "attributes": { + "firstName": "Dan", + "lastName": "Gebhardt", + "twitter": "dgeb" + }, + "links": { + "self": "http://example.com/people/9" + } + }, + { + "type": "comments", + "id": "5", + "attributes": { + "body": "First!" + }, + "relationships": { + "author": { + "data": { + "type": "people", + "id": "2" + } + } + }, + "links": { + "self": "http://example.com/comments/5" + } + }, + { + "type": "comments", + "id": "12", + "attributes": { + "body": "Second" + }, + "relationships": { + "author": { + "data": { + "type": "people", + "id": "9" + } + } + }, + "links": { + "self": "http://example.com/comments/12" + } + } + ] +} diff --git a/_schemas/1.0/tests/response/valid/with_success/data_and_meta.json b/_schemas/1.0/tests/response/valid/with_success/data_and_meta.json new file mode 100644 index 000000000..876733b27 --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/data_and_meta.json @@ -0,0 +1,12 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + } + }, + "meta": { + "anything": "valid" + } +} diff --git a/_schemas/1.0/tests/response/valid/with_success/data_is_null.json b/_schemas/1.0/tests/response/valid/with_success/data_is_null.json new file mode 100644 index 000000000..3356af5ff --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/data_is_null.json @@ -0,0 +1,3 @@ +{ + "data": null +} diff --git a/_schemas/1.0/tests/response/valid/with_success/linkage/empty_to_many.json b/_schemas/1.0/tests/response/valid/with_success/linkage/empty_to_many.json new file mode 100644 index 000000000..c202bd0ff --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/linkage/empty_to_many.json @@ -0,0 +1,14 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "comments": { + "data": [] + } + } + } +} diff --git a/_schemas/1.0/tests/response/valid/with_success/linkage/empty_to_one.json b/_schemas/1.0/tests/response/valid/with_success/linkage/empty_to_one.json new file mode 100644 index 000000000..029f01579 --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/linkage/empty_to_one.json @@ -0,0 +1,14 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "data": null + } + } + } +} diff --git a/_schemas/1.0/tests/response/valid/with_success/linkage/to_many.json b/_schemas/1.0/tests/response/valid/with_success/linkage/to_many.json new file mode 100644 index 000000000..254bd6f86 --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/linkage/to_many.json @@ -0,0 +1,34 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "comments": { + "links": { + "self": "http://example.com/articles/1/relationships/comments", + "related": "http://example.com/articles/1/comments", + "first": "http://example.com/articles/1/comments?page%5Bnumber%5D=1&page%5Bsize%5D=25", + "last": "http://example.com/articles/1/comments?page%5Bnumber%5D=1&page%5Bsize%5D=25", + "prev": null, + "next": null + }, + "data": [ + { + "type": "comment", + "id": "12" + }, + { + "type": "comment", + "id": "15", + "meta": { + "something": "ok" + } + } + ] + } + } + } +} diff --git a/_schemas/1.0/tests/response/valid/with_success/linkage/to_one.json b/_schemas/1.0/tests/response/valid/with_success/linkage/to_one.json new file mode 100644 index 000000000..931514c4e --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/linkage/to_one.json @@ -0,0 +1,20 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "comments": { + "data": { + "type": "people", + "id": "9", + "meta": { + "something": "ok" + } + } + } + } + } +} diff --git a/_schemas/1.0/tests/response/valid/with_success/only_data/empty_resource_collection.json b/_schemas/1.0/tests/response/valid/with_success/only_data/empty_resource_collection.json new file mode 100644 index 000000000..268c73f0e --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/only_data/empty_resource_collection.json @@ -0,0 +1,3 @@ +{ + "data": [] +} diff --git a/_schemas/1.0/tests/response/valid/with_success/only_data/no_resource_null.json b/_schemas/1.0/tests/response/valid/with_success/only_data/no_resource_null.json new file mode 100644 index 000000000..3356af5ff --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/only_data/no_resource_null.json @@ -0,0 +1,3 @@ +{ + "data": null +} diff --git a/_schemas/1.0/tests/response/valid/with_success/only_data/parallel_relationships.json b/_schemas/1.0/tests/response/valid/with_success/only_data/parallel_relationships.json new file mode 100644 index 000000000..146f87f46 --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/only_data/parallel_relationships.json @@ -0,0 +1,33 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "author": { + "data": [ + { + "type": "people", + "id": "9" + }, + { + "type": "people", + "id": "9" + } + ] + } + } + }, + "meta": { + "errors-present-in-document": [ + { + "detail": "A document **MUST NOT** include more than one resource object for each \"type\" and \"id\" pair.", + "source": { + "pointer": "/data/relationships/author/data" + } + } + ] + } +} diff --git a/_schemas/1.0/tests/response/valid/with_success/only_data/resource_collection.json b/_schemas/1.0/tests/response/valid/with_success/only_data/resource_collection.json new file mode 100644 index 000000000..9a5953955 --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/only_data/resource_collection.json @@ -0,0 +1,28 @@ +{ + "data": [ + { + "type": "article", + "id": "1", + "attributes": { + "something": true, + "title": "first article" + } + }, + { + "type": "article", + "id": "2", + "attributes": { + "something": true, + "title": "second article" + } + }, + { + "type": "article", + "id": "3", + "attributes": { + "something": false, + "title": "third article" + } + } + ] +} diff --git a/_schemas/1.0/tests/response/valid/with_success/only_data/resource_identifier_collection.json b/_schemas/1.0/tests/response/valid/with_success/only_data/resource_identifier_collection.json new file mode 100644 index 000000000..8fa3edff3 --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/only_data/resource_identifier_collection.json @@ -0,0 +1,16 @@ +{ + "data": [ + { + "type": "article", + "id": "1" + }, + { + "type": "article", + "id": "2" + }, + { + "type": "article", + "id": "3" + } + ] +} diff --git a/_schemas/1.0/tests/response/valid/with_success/only_data/single_resource.json b/_schemas/1.0/tests/response/valid/with_success/only_data/single_resource.json new file mode 100644 index 000000000..e2dc7db4c --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/only_data/single_resource.json @@ -0,0 +1,16 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": { + "title": "JSON:API, a specification for building APIs in JSON" + }, + "relationships": { + "toMany": { + "links": { + "self": "http://example.com/something/to-many" + } + } + } + } +} diff --git a/_schemas/1.0/tests/response/valid/with_success/only_data/single_resource_identifier.json b/_schemas/1.0/tests/response/valid/with_success/only_data/single_resource_identifier.json new file mode 100644 index 000000000..54f60a2ba --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/only_data/single_resource_identifier.json @@ -0,0 +1,6 @@ +{ + "data": { + "type": "article", + "id": "1" + } +} diff --git a/_schemas/1.0/tests/response/valid/with_success/only_data/single_resource_with_empty_attributes.json b/_schemas/1.0/tests/response/valid/with_success/only_data/single_resource_with_empty_attributes.json new file mode 100644 index 000000000..661865dd1 --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/only_data/single_resource_with_empty_attributes.json @@ -0,0 +1,7 @@ +{ + "data": { + "type": "article", + "id": "1", + "attributes": {} + } +} diff --git a/_schemas/1.0/tests/response/valid/with_success/only_meta.json b/_schemas/1.0/tests/response/valid/with_success/only_meta.json new file mode 100644 index 000000000..af6e064a0 --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/only_meta.json @@ -0,0 +1,9 @@ +{ + "meta": { + "anything": "valid", + "count": 3, + "object": { + "attr": "value" + } + } +} diff --git a/_schemas/1.0/tests/response/valid/with_success/only_meta/empty_meta.json b/_schemas/1.0/tests/response/valid/with_success/only_meta/empty_meta.json new file mode 100644 index 000000000..6da7422b1 --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/only_meta/empty_meta.json @@ -0,0 +1,3 @@ +{ + "meta": {} +} diff --git a/_schemas/1.0/tests/response/valid/with_success/only_meta/meta_with_members.json b/_schemas/1.0/tests/response/valid/with_success/only_meta/meta_with_members.json new file mode 100644 index 000000000..af6e064a0 --- /dev/null +++ b/_schemas/1.0/tests/response/valid/with_success/only_meta/meta_with_members.json @@ -0,0 +1,9 @@ +{ + "meta": { + "anything": "valid", + "count": 3, + "object": { + "attr": "value" + } + } +} diff --git a/_schemas/scripts/validator.js b/_schemas/scripts/validator.js new file mode 100644 index 000000000..539b749e3 --- /dev/null +++ b/_schemas/scripts/validator.js @@ -0,0 +1,317 @@ +// Import the modules +const Ajv2020 = require("ajv/dist/2020"); +const addFormats = require("ajv-formats"); +const readdirp = require("readdirp"); +const npath = require("path"); +const { compareVersions } = require("compare-versions"); + +/** + * Retrieve the value of the given option. + * @param {String} name - The name of the option to retrieve + * @param {*} defaultValue - The default value + * @returns {*} + */ +const getArgValue = function (name, defaultValue) { + const index = process.argv.indexOf(name); + let value; + + if (index > -1) { + // Retrieve the value after --custom + value = process.argv[index + 1]; + } + + return (value || defaultValue); +}; + +// Define root dir +const rootDir = "./_schemas"; + +// Define object that will record the full path of all files tested +const files = {}; + +// Check for options +const options = { + verbose: process.argv.indexOf("--verbose") > -1, + requiredVersion: getArgValue("-v"), + requiredFile: getArgValue("-f"), + + onlyOneVersion: function () { + return typeof this.requiredVersion !== "undefined"; + }, + onlyForVersion: function (version) { + return this.onlyOneVersion() && this.requiredVersion === version; + }, + singleTest: function() { + return (typeof this.requiredFile !== "undefined"); + } +}; + +// Main function +(async function () { + try { + // List all the available versions of the spec + for await (const entry of readdirp(rootDir, { depth: 0, entryType: "directories" })) { + const version = entry.path; + if (isNaN(version)) { + continue; + } + + // For this version, ... + + // ... prepare record object + files[version] = new Array(); + + // ... if not required to test this version, register all version-specific test files + if (options.onlyOneVersion() && !options.onlyForVersion(version)) { + await readTestDir(version); + continue; + } + + // ... log some infos + console.log(""); + console.log("JSON:API spec version : %s", version); + console.log(""); + + // ... create ajv instance + const ajv = ajvFactory(); + + // ... add schemas to ajv instance + await addSchemas(ajv, version); + + // ... test all files + const { ok, ko } = await handleTests(ajv, version); + + // ... log the results + if (options.verbose) { + console.log(""); + } + console.log("Tests done : %d, success : %d, errors : %d", ko.length + ok.length, ok.length, ko.length); + if (ko.length != 0) { + ko.forEach(item => { + console.log(""); + console.log(item.relativePath + " should be " + (item.shouldBeValid ? "valid" : "invalid") + " but is not."); + console.log(" spec version : " + item.version); + console.log(" absolute path : " + item.fullPath); + console.log(" errors : "); + console.log(item.errors.map(err => " " + err.instancePath + " : " + err.message).join("\n")); + }); + + } + + // ... define the exit code + process.exitCode = (ko.length != 0) ? 1 : 0; + } + } catch (err) { + console.log(err); + process.exitCode = 2; + } +})() + +/** + * Generate new instance of Ajv validator. + * @returns {Ajv2020} - An instance of Ajv validator + */ +const ajvFactory = function () { + // ... create ajv instance + const ajv = new Ajv2020(); + + // ...add formats to ajv validator + addFormats(ajv); + + return ajv; +}; + +/** + * Load all version-related schemas and register them with the instance of the Ajv validator. + * @param {Ajv2020} ajv - An instance of Ajv validator + * @param {String} version - The version of the JSON:API spec that will be validated + * @return {void} + */ +const addSchemas = async function (ajv, version) { + for await (const entry of readdirp(`${rootDir}/${version}/`, { depth: 0, fileFilter: "*.json" })) { + const { path, fullPath } = entry; + + // Load schema file + const schema = require(fullPath); + + // Build the schema key to be used + const t = path.split(".").shift().split("_"); + t.shift(); + const t2 = t.join("_"); + const key = t2 === "" ? "response" : "request_" + t2; + + // Add schema to the Ajv validator instance + ajv.addSchema(schema, key); + + if (options.verbose) { + console.log("Add schema : %s => %s", key, fullPath); + } + } + if (options.verbose) { + console.log(""); + } +}; + +/** + * Check all the test files for the given version of the JSON:API spec. + * @param {Ajv2020} ajv - An instance of Ajv validator + * @param {String} version - The version of the JSON:API spec that will be validated + * @return {{ok: String[], ko: String[]}} - The results of the tests. + */ +const handleTests = async function (ajv, version) { + // Define some constants + const results = { + ok: new Array(), + ko: new Array() + }; + + if (options.singleTest()) { + await runSingleTest(ajv, version, results); + } else { + await runAllTests(ajv, version, results); + } + + return results; +}; + +/** + * Check all the test files for the given version of the JSON:API spec. + * @param {Ajv2020} ajv - An instance of Ajv validator + * @param {String} version - The version of the JSON:API spec that will be validated + * @param {{ok: String[], ko: String[]}} results - The results of the tests. + * @return {void} + */ +const runAllTests = async function (ajv, version, results) { + // Build a list of test files from previous versions + const tmpFiles = new Array(); + for (const v in files) { + if (compareVersions(version, v) === 1) { + tmpFiles.push(...files[v]); + } + } + + // Validate each file of previous versions + tmpFiles.forEach(item => { + runTest(ajv, version, item.relativePath, item.fullPath, results); + }); + + // Iterate through version-specifiques test files + await readTestDir(version, (path, fullPath) => { + // Validate test file + runTest(ajv, version, path, fullPath, results); + }) +}; + +/** + * Run a single test for the given version of the JSON:API spec and the test file that was passed in the options. + * @param {Ajv2020} ajv - An instance of Ajv validator + * @param {String} version - The version of the JSON:API spec that will be validated + * @param {{ok: String[], ko: String[]}} results - The result of the test. + * @return {void} + */ +const runSingleTest = async function (ajv, version, results) { + // Retrieve relative and full path of the file to test + const baseDir = __dirname.replaceAll(/[\/\\]/g, npath.sep).split(npath.sep); + baseDir.pop(); + const filePath = options.requiredFile.replaceAll(/[\/\\]/g, npath.sep).split(npath.sep); + if (filePath[0] === "_schemas") { + filePath.shift(); + } + const fullPath = [...baseDir, ...filePath].join(npath.sep); + + filePath.shift(); + filePath.shift(); + const path = filePath.join(npath.sep); + + // Validate test file + runTest(ajv, version, path, fullPath, results); +}; + +/** + * Check a single test files for the given version of the JSON:API spec. + * @param {Ajv2020} ajv - An instance of Ajv validator + * @param {String} version - The version of the JSON:API spec that will be validated + * @param {String} relativePath - The relative path of the test file that will be validated + * @param {String} fullPath - The absolute path of the test file that will be validated + * @param {{ok: String[], ko: String[]}} results - The results of the test. + * @return {void} + */ +const runTest = function (ajv, version, relativePath, fullPath, results) { + // Validate test file + const result = doTest(ajv, version, relativePath, fullPath); + + // Handle validation result + if (result.ok) { + results.ok.push(result); + } else { + results.ko.push(result); + } +}; + + +/** + * Load the list of test files for the given version of the JSON:API spec. + * @param {String} version - The version of the JSON:API spec that will be validated + * @param {Function} callback - A callback function to execute for each test file with path (relative path of test file) and fullPath (absolute path of test file) as arguments. + * @return {void} + */ +const readTestDir = async function (version, callback) { + // Iterate through version-specifiques test files + for await (const entry of readdirp(`${rootDir}/${version}/tests/`, { fileFilter: "*.json" })) { + const { path, fullPath } = entry; + + if (callback) { + callback(path, fullPath); + } + // Record file path + files[version].push({ + relativePath: path, + fullPath: fullPath + }); + } +}; + +/** + * validate a test file for the given version of the JSON:API spec. + * @param {Ajv2020} ajv - An instance of Ajv validator + * @param {String} version - The version of the JSON:API spec that will be validated + * @param {String} relativePath - The relative path of the file to validate. + * @param {String} fullPath - The absolute path of the file to validate. + * @return {{version: String, relativePath: String, fullPath: String, ok : Boolean, errors: Object}} - The result of the validation. + */ +const doTest = function (ajv, version, relativePath, fullPath) { + if (options.verbose) { + console.log("testing : %s : %s", version, fullPath); + } + + // Load file + const data = require(fullPath); + + // Build the schema key to be used + const re = new RegExp("(.*)\\" + npath.sep + "(in)?valid\\" + npath.sep); + const matches = relativePath.match(re); + const valid_data = typeof matches[2] === "undefined"; + + const t = matches[1].split(npath.sep); + const key = [ + t.shift(), + ...t.reverse() + ]; + + // Generate validating function + const validate = ajv.getSchema(key.join("_")); + + // Validate file + const valid = validate(data); + const ok = (valid && valid_data) || (!valid && !valid_data); + + // Return result of validation + return { + version: version, + relativePath: relativePath, + fullPath: fullPath, + shouldBeValid: valid_data, + ok: ok, + errors: !ok ? validate.errors : undefined + }; +}; diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 000000000..f95b1fe3b --- /dev/null +++ b/package-lock.json @@ -0,0 +1,117 @@ +{ + "name": "json-api", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "devDependencies": { + "ajv": "^8.12.0", + "ajv-formats": "^2.1.1", + "compare-versions": "^6.1.0", + "readdirp": "^3.6.0" + } + }, + "node_modules/ajv": { + "version": "8.12.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.12.0.tgz", + "integrity": "sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ajv-formats": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-2.1.1.tgz", + "integrity": "sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA==", + "dev": true, + "dependencies": { + "ajv": "^8.0.0" + }, + "peerDependencies": { + "ajv": "^8.0.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/compare-versions": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/compare-versions/-/compare-versions-6.1.0.tgz", + "integrity": "sha512-LNZQXhqUvqUTotpZ00qLSaify3b4VFD588aRr8MKFw4CMUr98ytzCW5wDH5qx/DEY5kCDXcbcRuCqL0szEf2tg==", + "dev": true + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true + }, + "node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true + }, + "node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "dev": true, + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/punycode": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.0.tgz", + "integrity": "sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/readdirp": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", + "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", + "dev": true, + "dependencies": { + "picomatch": "^2.2.1" + }, + "engines": { + "node": ">=8.10.0" + } + }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, + "dependencies": { + "punycode": "^2.1.0" + } + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 000000000..c5d527681 --- /dev/null +++ b/package.json @@ -0,0 +1,11 @@ +{ + "devDependencies": { + "ajv": "^8.12.0", + "ajv-formats": "^2.1.1", + "compare-versions": "^6.1.0", + "readdirp": "^3.6.0" + }, + "scripts": { + "test-schema": "node -i _schemas/scripts/validator.js" + } +} \ No newline at end of file diff --git a/schema b/schema deleted file mode 100644 index 56a404c2e..000000000 --- a/schema +++ /dev/null @@ -1,397 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "JSON:API Schema", - "description": "This is a schema for responses in the JSON:API format. For more, see http://jsonapi.org", - "oneOf": [ - { - "$ref": "#/definitions/success" - }, - { - "$ref": "#/definitions/failure" - }, - { - "$ref": "#/definitions/info" - } - ], - - "definitions": { - "success": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/definitions/data" - }, - "included": { - "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", - "type": "array", - "items": { - "$ref": "#/definitions/resource" - }, - "uniqueItems": true - }, - "meta": { - "$ref": "#/definitions/meta" - }, - "links": { - "description": "Link members related to the primary data.", - "allOf": [ - { - "$ref": "#/definitions/links" - }, - { - "$ref": "#/definitions/pagination" - } - ] - }, - "jsonapi": { - "$ref": "#/definitions/jsonapi" - } - }, - "additionalProperties": false - }, - "failure": { - "type": "object", - "required": [ - "errors" - ], - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/error" - }, - "uniqueItems": true - }, - "meta": { - "$ref": "#/definitions/meta" - }, - "jsonapi": { - "$ref": "#/definitions/jsonapi" - }, - "links": { - "$ref": "#/definitions/links" - } - }, - "additionalProperties": false - }, - "info": { - "type": "object", - "required": [ - "meta" - ], - "properties": { - "meta": { - "$ref": "#/definitions/meta" - }, - "links": { - "$ref": "#/definitions/links" - }, - "jsonapi": { - "$ref": "#/definitions/jsonapi" - } - }, - "additionalProperties": false - }, - - "meta": { - "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", - "type": "object", - "additionalProperties": true - }, - "data": { - "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", - "oneOf": [ - { - "$ref": "#/definitions/resource" - }, - { - "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", - "type": "array", - "items": { - "$ref": "#/definitions/resource" - }, - "uniqueItems": true - }, - { - "description": "null if the request is one that might correspond to a single resource, but doesn't currently.", - "type": "null" - } - ] - }, - "resource": { - "description": "\"Resource objects\" appear in a JSON:API document to represent resources.", - "type": "object", - "required": [ - "type", - "id" - ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string" - }, - "attributes": { - "$ref": "#/definitions/attributes" - }, - "relationships": { - "$ref": "#/definitions/relationships" - }, - "links": { - "$ref": "#/definitions/links" - }, - "meta": { - "$ref": "#/definitions/meta" - } - }, - "additionalProperties": false - }, - "relationshipLinks": { - "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", - "type": "object", - "properties": { - "self": { - "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", - "$ref": "#/definitions/link" - }, - "related": { - "$ref": "#/definitions/link" - } - }, - "additionalProperties": true - }, - "links": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/link" - } - }, - "link": { - "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", - "oneOf": [ - { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - { - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - "meta": { - "$ref": "#/definitions/meta" - } - } - } - ] - }, - - "attributes": { - "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", - "type": "object", - "patternProperties": { - "^[a-zA-Z0-9](?:[-\\w]*[a-zA-Z0-9])?$": { - "description": "Attributes may contain any valid JSON value." - } - }, - "not": { - "anyOf": [ - {"required": ["relationships"]}, - {"required": ["links"]}, - {"required": ["id"]}, - {"required": ["type"]} - ] - }, - "additionalProperties": false - }, - - "relationships": { - "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", - "type": "object", - "patternProperties": { - "^[a-zA-Z0-9](?:[-\\w]*[a-zA-Z0-9])?$": { - "properties": { - "links": { - "$ref": "#/definitions/relationshipLinks" - }, - "data": { - "description": "Member, whose value represents \"resource linkage\".", - "oneOf": [ - { - "$ref": "#/definitions/relationshipToOne" - }, - { - "$ref": "#/definitions/relationshipToMany" - } - ] - }, - "meta": { - "$ref": "#/definitions/meta" - } - }, - "anyOf": [ - {"required": ["data"]}, - {"required": ["meta"]}, - {"required": ["links"]} - ], - "not": { - "anyOf": [ - {"required": ["id"]}, - {"required": ["type"]} - ] - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "relationshipToOne": { - "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.", - "anyOf": [ - { - "$ref": "#/definitions/empty" - }, - { - "$ref": "#/definitions/linkage" - } - ] - }, - "relationshipToMany": { - "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", - "type": "array", - "items": { - "$ref": "#/definitions/linkage" - }, - "uniqueItems": true - }, - "empty": { - "description": "Describes an empty to-one relationship.", - "type": "null" - }, - "linkage": { - "description": "The \"type\" and \"id\" to non-empty members.", - "type": "object", - "required": [ - "type", - "id" - ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string" - }, - "meta": { - "$ref": "#/definitions/meta" - } - }, - "additionalProperties": false - }, - "pagination": { - "type": "object", - "properties": { - "first": { - "description": "The first page of data", - "oneOf": [ - { "$ref": "#/definitions/link" }, - { "type": "null" } - ] - }, - "last": { - "description": "The last page of data", - "oneOf": [ - { "$ref": "#/definitions/link" }, - { "type": "null" } - ] - }, - "prev": { - "description": "The previous page of data", - "oneOf": [ - { "$ref": "#/definitions/link" }, - { "type": "null" } - ] - }, - "next": { - "description": "The next page of data", - "oneOf": [ - { "$ref": "#/definitions/link" }, - { "type": "null" } - ] - } - } - }, - - "jsonapi": { - "description": "An object describing the server's implementation", - "type": "object", - "properties": { - "version": { - "type": "string" - }, - "meta": { - "$ref": "#/definitions/meta" - } - }, - "additionalProperties": false - }, - - "error": { - "type": "object", - "properties": { - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "type": "string" - }, - "links": { - "$ref": "#/definitions/links" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "type": "string" - }, - "code": { - "description": "An application-specific error code, expressed as a string value.", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "type": "string" - }, - "source": { - "type": "object", - "properties": { - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].", - "type": "string" - }, - "parameter": { - "description": "A string indicating which query parameter caused the error.", - "type": "string" - } - } - }, - "meta": { - "$ref": "#/definitions/meta" - } - }, - "additionalProperties": false - } - } -} - From 6f85ee971b71ec34e58bbcb14858015a655aeaa7 Mon Sep 17 00:00:00 2001 From: Guille Gonzalez Date: Tue, 18 Jun 2024 19:47:00 +0200 Subject: [PATCH 75/93] Add Datadog/swift-jsonapi to the implementations section (#1748) --- implementations/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/implementations/index.md b/implementations/index.md index 3939939a4..f650295d3 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -76,6 +76,7 @@ isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and i * [Japx](https://github.com/infinum/Japx) is lightweight JSON:API parser that flattens complex JSON:API structure and turns it into simple JSON and vice versa. It works by transferring Dictionary to Dictionary, so you can use Codable, Unbox, Wrap, ObjectMapper or any other object mapping tool that you prefer. It supports Objective-C as well. * [mattpolzin / JSONAPI](https://github.com/mattpolzin/JSONAPI) is a Swift Codable library with heavy emphasis on type-safety. It is platform agnostic so it can be used client- and server-side. * [IzzyParser](https://github.com/undabot/izzyparser-ios) is a lightweight library for serializing and deserializing JSON:API objects. +* [Datadog/swift-jsonapi](https://github.com/Datadog/swift-jsonapi) is a Swift library that provides macros to simplify the encoding and decoding of JSON:API responses. ### Ruby @@ -156,6 +157,7 @@ and writing of JSON:API documents. ### Swift * [aonawale / JSONAPISerializer](https://github.com/aonawale/JSONAPISerializer) is a server side swift framework agnostic library that implements JSON:API v1.0. * [mattpolzin / JSONAPI](https://github.com/mattpolzin/JSONAPI) is a Swift Codable library with heavy emphasis on type-safety. It is platform agnostic so it can be used client- and server-side. +* [Datadog/swift-jsonapi](https://github.com/Datadog/swift-jsonapi) is a Swift library that provides macros to simplify the encoding and decoding of JSON:API responses. ### PHP From 2fd0b559a4544039ea15f4807392af42aae91169 Mon Sep 17 00:00:00 2001 From: Caio Tarifa Date: Tue, 18 Jun 2024 14:50:49 -0300 Subject: [PATCH 76/93] feat: add `fetchja` library on JavaScript implementations (#1747) --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index f650295d3..2beec077b 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -54,6 +54,7 @@ isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and i * [mobx-async-store](https://github.com/artemis-ag/mobx-async-store) - A Mobx-based store for async data fetching and state management for the JSON:API specification. * [spraypaint](https://github.com/graphiti-api/spraypaint.js) - JS Client for Graphiti similar to ActiveRecord. Written in Typescript but works in plain old ES5 as well. This library is isomorphic - use it from the browser, or from the server with NodeJS. * [json-api-models](https://github.com/tobyzerner/json-api-models) - A lightweight layer for working with JSON:API data. +* [fetchja](https://github.com/caiotarifa/fetchja) - A super simple, modern, and lightweight library for dealing with JSON:API (Kitsu-like, but using Fetch API instead of Axios). ### Typescript * [ts-angular-jsonapi](https://github.com/reyesoft/ts-angular-jsonapi) A JSON:API library developed for AngularJS in Typescript From 77bc3cbbaf5cf04f25cb592dade51e0c830cde95 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Thu, 15 Aug 2024 22:28:05 +0200 Subject: [PATCH 77/93] top-level links object is related to the document in some cases (#1753) * top-level links object is related to the document in some cases The top-level `links` object is related to the whole document in 2 out of 4 cases: `self` and `describedby` links are related to the document. Not only to its primary data. Even more they are useful even if a document does not have primary data. A document could not have primary data if 1) being an error response, 2) a response to a successful mutation, and 3) having an extension applied. Top-level links, especially `self`, are commonly used in those cases. And intended to be used. This PR improves the wording of the specification to avoid confusion. It was motivated by this thread in the discussion forum: https://jsonapi.org/format/ * fix typo --- _format/1.2/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index 653d9dab0..17a5a986d 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -303,7 +303,7 @@ The members `data` and `errors` **MUST NOT** coexist in the same document. A document **MAY** contain any of these top-level members: * `jsonapi`: an object describing the server's implementation. -* `links`: a [links object][links] related to the primary data. +* `links`: a [links object][links] related to the document as a whole. * `included`: an array of [resource objects] that are related to the primary data and/or each other ("included resources"). From 5361a05650f4b9ef4cec36188289a13c2a7ed46b Mon Sep 17 00:00:00 2001 From: Spenser Hale Date: Tue, 17 Sep 2024 09:43:52 -0700 Subject: [PATCH 78/93] Auditing implementations links (#1741) Removing implementations and tools that no longer exist or archived Javascript - backbone-jsonapi Node.js - transformalizer Ruby - jsonapi-simple_client - jsonapi-record Elixir - JsonApiClient Playground - jsonapi-validator - JSON API Playground Updating Links: JavaScript - JSONAPI Suite --- implementations/index.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/implementations/index.md b/implementations/index.md index 2beec077b..9eb32e247 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -16,7 +16,6 @@ assembled to vet them. ### JavaScript * [ember-data](https://github.com/emberjs/data) is one of the original exemplar implementations. There is now an [official adapter](https://emberjs.com/api/ember-data/release/classes/DS.JSONAPIAdapter) to support json-api. -* [backbone-jsonapi](https://github.com/guillaumervls/backbone-jsonapi) is a Backbone adapter for JSON:API. Supports fetching Models & Collections from a JSON:API source. * [backbone-relational-jsonapi](https://github.com/xbill82/backbone-relational-jsonapi) is a parsing layer for Backbone.Relational. Entities specified in JSON:API are automatically parsed to be injected into Backbone.Relational relations. * [orbit.js](https://github.com/orbitjs/orbit.js) is a standalone library for coordinating access to data sources and keeping their contents synchronized. @@ -42,8 +41,8 @@ assembled to vet them. * [Sarala JSON API data formatter](https://github.com/milroyfraser/sarala-json-api-data-formatter) is a simple and fluent framework agnostic javascript library to transform standard JSON:API responses to simple JSON objects and vice versa. * [Sarala](https://github.com/milroyfraser/sarala) is a javascript package which gives you a [Laravel Eloquent](https://laravel.com/docs/5.6/eloquent) like syntax to perform CRUD operations against an JSON:API built according to [JSON:API specification](http://jsonapi.org/format/). * [jsonapi-client](https://github.com/itsfadnis/jsonapi-client) A convenient module to consume a jsonapi service -* [JSORM](https://jsonapi-suite.github.io/jsonapi_suite/js/home) is an -isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and is part of the larger [JSONAPI Suite](https://jsonapi-suite.github.io/jsonapi_suite). +* [JSORM](https://github.com/jsonapi-suite/jsorm) is an +isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and is part of the larger [JSONAPI Suite](https://github.com/jsonapi-suite/). * [jsonapi-vuex](https://github.com/mrichar1/jsonapi-vuex) A module for interacting with a jsonapi service using a Vuex store, restructuring/normalizing records to make life easier. * [heather-js](https://github.com/bitex-la/heather-js) A library for parsing JSONAPI into objects from ES6 classes. * [@hyral/core](https://github.com/SyneticNL/Hyral) - An advanced, documented, easily extendable and lightweight (JSON:)API abstraction library with ORM-like CRUD support, automatic relationships handling and support for multiple (different) backends. @@ -86,8 +85,6 @@ isomorphic ActiveRecord clone that issues JSON:API requests instead of SQL and i * [Munson](https://github.com/coryodaniel/munson) is a ruby JSONAPI client that can act as an ORM or integrate with your models via fine-grained agnosticism. Easy to configure and customize. Includes a chainable/customizable query builder, attributes API and dirty tracking. * [json-api-vanilla](https://github.com/trainline/json-api-vanilla) a reference-aware ruby library for JSONAPI deserialization that doesn't require setting up classes. * [SimpleJSONAPIClient](https://github.com/amcaplan/simple_jsonapi_client) gives you lower-level control for API operations, while your models and their relationships maintain a neat, ActiveRecord-inspired interface. -* [jsonapi-simple_client](https://github.com/InspireNL/jsonapi-simple_client) a client to interact with a Server API that implements the JSON:API spec. -* [jsonapi-record](https://github.com/InspireNL/jsonapi-record) a client framework for interacting JSON:API Spec compliant APIs in Ruby. * [jsonapi-unwrapper](https://github.com/Sonberg/jsonapi-unwrapper) a simple and lightweight library to deserialize JSON:API payloads. ### PHP @@ -149,10 +146,6 @@ and writing of JSON:API documents. * [json-api-doc](https://github.com/noplay/json-api-doc) JSON:API parser returning a simple Python dictionary * [json-api-smart](https://github.com/NilssonPL/json-api-smart) JSON:API with an ORM interface -### Elixir - -* [JsonApiClient](https://github.com/Decisiv/json_api_client) JSON:API Client Library For Elixir - ## Server libraries ### Swift @@ -209,7 +202,6 @@ and writing of JSON:API documents. * [json-api-ify](https://github.com/kutlerskaggs/json-api-ify) serialize the **** out of your data. json:api v1.0 complaint. * [bookshelf-jsonapi-params](https://github.com/scoutforpets/bookshelf-jsonapi-params) automatically apply JSON:API filtering, pagination, sparse fieldsets, includes, and sorting to your Bookshelf.js queries. * [Lux](https://github.com/postlight/lux) is a MVC style Node.js framework for building lightning fast JSON:APIs. -* [transformalizer](https://github.com/GaiamTV/transformalizer) a bare bones node module for transforming raw data into JSON:API compliant payloads that makes no assumption regarding the shape of your data and sdks used, supports the full v1.0 specification, and supports dynamic transformations, links, and meta at all levels of a document. * [jsonapi-mock](https://github.com/Thomas-X/jsonapi-mock) A [json-server](https://github.com/typicode/json-server) inspired jsonapi mock server. Setup a jsonapi mock server in almost no time, uses lowdb. * [DenaliJS](http://denalijs.org) A layered-conventions framework for building ambitious APIs. Includes a powerful addon system, best-in-class developer experience, and extensive documentation. * [jsonapi-fractal](https://github.com/andersondanilo/jsonapi-fractal) JSON:API Serializer inspired by Fractal (PHP) @@ -238,7 +230,7 @@ the moment. * [JSONAPI::Resources](https://github.com/cerebris/jsonapi-resources) provides a complete framework for developing a JSON:API server. It is designed to work with Rails, and provides routes, controllers, and serializers. * [JSONAPI::Utils](https://github.com/b2beauty/jsonapi-utils) works on top of [JSONAPI::Resources](https://github.com/cerebris/jsonapi-resources) taking advantage of its resource-driven style and bringing a Rails way to build modern APIs with no or less learning curve. * [Caprese](https://github.com/nicklandgrebe/caprese) An opinionated Rails library for creating JSON:API servers that lets you focus on customizing the behavior of your endpoints rather than the dirty work of setting them up. Leverages the power of [ActiveModel::Serializer](https://github.com/rails-api/active_model_serializers). - * [JSONAPI Suite](https://jsonapi-suite.github.io/jsonapi_suite) + * [JSONAPI Suite](https://github.com/jsonapi-suite) facilitates a server capable of deep querying and nested writes. Works with any ORM or datastore; comes with integration test helpers and automatic swagger documentation. @@ -349,9 +341,7 @@ includes related resources. ### Playground * [json-api-document-viewer](https://tadast.github.io/json-api-document-viewer) the flat json:api structure is a good way to express complex relationships between objects. However the same flatness makes it difficult for humans to "parse" these relationships. This tool visualises object relationships by visually nesting them. -* [jsonapi-validator](https://jsonapi-validator.herokuapp.com) is a playground service for quick prototyping and validating JSON responses with jsonapi.org specification. * [corroborate](http://corroborate.arenpatel.com/) JSON:API request/response payload validator. It warns when there is a specification violation and also informs when a recommendation has not been followed. -* [JSON API Playground](http://jsonapiplayground.reyesoft.com/) Fake online JSON:API server for testing and prototyping. It's great for tutorials, faking a server, sharing code examples, etc. ### Ruby From 0c29063ffd141e821565a0762313af5311234a38 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Tue, 17 Sep 2024 18:53:35 +0200 Subject: [PATCH 79/93] backporting the clarification of top-level links object to v1.1 (#1754) The clarification was merged to v1.2 (upcoming) in #1753. This backports the changes to v1.1. --- _format/1.1/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 5271037ad..36c813c6e 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -302,7 +302,7 @@ The members `data` and `errors` **MUST NOT** coexist in the same document. A document **MAY** contain any of these top-level members: * `jsonapi`: an object describing the server's implementation. -* `links`: a [links object][links] related to the primary data. +* `links`: a [links object][links] related to the document as a whole. * `included`: an array of [resource objects] that are related to the primary data and/or each other ("included resources"). From 1aa4b2f4dc2fea6937aa0cfbe1eac9f450775621 Mon Sep 17 00:00:00 2001 From: "s.mareychev" Date: Mon, 7 Oct 2024 16:42:20 +0400 Subject: [PATCH 80/93] Add jsonapi-simple JAVA package to implementations --- implementations/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/implementations/index.md b/implementations/index.md index 9eb32e247..28bd5a27c 100644 --- a/implementations/index.md +++ b/implementations/index.md @@ -298,6 +298,7 @@ includes related resources. * [jsonapi-rvp](https://github.com/xlate/jsonapi-rvp) utilizes the platform capabilities available in the Jakarta EE environment (formerly Java EE) to expose JPA entities via JSON:API. Features include query and entity validation (using Bean Validators), pagination, use of surrogate keys as record identifiers, support for LEFT outer join conditions, and a simple JavaScript client. * [JSON:API object converter](https://github.com/MieskeB/json-api-spring-boot) converts normal Java objects to JSON:API standard with the use of annotations in the viewmodels (dtos). * [Dashjoin Low Code Development Platform](https://github.com/dashjoin/platform) connects to relational, document, and graph databases and makes them available via JSON:API. The platform offers powerful access control mechanisms, a query editor, and graphical layout designers. +* [jsonapi-simple](https://github.com/devslm/jsonapi-simple) is a simple implementation of the JSON:API specification (only required output fields). This library implements only top-level fields: data, links, errors and meta (using spring boot dependencies) without any relationships, includes and others. It implemented also filtering, sorting and sparse fieldset. [See the documentation](https://devslm.github.io/jsonapi-simple/) for full details. ### Scala * [scala-jsonapi](https://github.com/scala-jsonapi/scala-jsonapi) A Scala library for producing JSON output (and deserializing JSON input) based on JSON:API specification. From c563ae3bea1610e56e39f21fab42f0bea047d4c0 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Tue, 22 Oct 2024 16:40:29 +0200 Subject: [PATCH 81/93] media type parameters should be delimited by an immediately preceding semicolony --- _format/1.2/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index 17a5a986d..b34ade3ec 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -50,7 +50,7 @@ The JSON:API specification supports two media type parameters: `ext` and > Note: A media type parameter is an extra piece of information that can accompany a media type. For example, in the header -`Content-Type: text/html; charset="utf-8"`, the media type is `text/html` and +`Content-Type: text/html;charset="utf-8"`, the media type is `text/html` and `charset` is a parameter. ### Extensions @@ -121,7 +121,7 @@ versioning. This member might appear as follows: ```json HTTP/1.1 200 OK -Content-Type: application/vnd.api+json; ext="https://jsonapi.org/ext/version" +Content-Type: application/vnd.api+json;ext="https://jsonapi.org/ext/version" // ... { @@ -170,7 +170,7 @@ With such a profile applied, a response might appear as follows: ```json HTTP/1.1 200 OK -Content-Type: application/vnd.api+json; profile="https://example.com/resource-timestamps" +Content-Type: application/vnd.api+json;profile="https://example.com/resource-timestamps" // ... { From 353ef57f262c06e3cbd49065739ac6e009ce713c Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Tue, 22 Oct 2024 16:43:27 +0200 Subject: [PATCH 82/93] Backport changes to v1.1 --- _format/1.1/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 36c813c6e..14eaa4f6f 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -49,7 +49,7 @@ The JSON:API specification supports two media type parameters: `ext` and > Note: A media type parameter is an extra piece of information that can accompany a media type. For example, in the header -`Content-Type: text/html; charset="utf-8"`, the media type is `text/html` and +`Content-Type: text/html;charset="utf-8"`, the media type is `text/html` and `charset` is a parameter. ### Extensions @@ -120,7 +120,7 @@ versioning. This member might appear as follows: ```json HTTP/1.1 200 OK -Content-Type: application/vnd.api+json; ext="https://jsonapi.org/ext/version" +Content-Type: application/vnd.api+json;ext="https://jsonapi.org/ext/version" // ... { @@ -169,7 +169,7 @@ With such a profile applied, a response might appear as follows: ```json HTTP/1.1 200 OK -Content-Type: application/vnd.api+json; profile="https://example.com/resource-timestamps" +Content-Type: application/vnd.api+json;profile="https://example.com/resource-timestamps" // ... { From ddcec33556a2bca7c93fbcbc823cff5dd42e2b7a Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Thu, 31 Oct 2024 08:43:14 +0100 Subject: [PATCH 83/93] Clarify combination of JSON:API with other standars JSON:API can and should be combined with other standards. But there has been some confusion about it in the past. E.g. people tried using it for authentication concerns such as login instead of established standards such as OAuth 2.0. Others assumed an API implementing JSON:API cannot support file upload. There seems to be a need clarifying it in the specification to avoid such confusion going forward. --- _format/1.2/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index b34ade3ec..708d42606 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -13,6 +13,8 @@ JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. +JSON:API can and should be combined with additional standards addressing other needs of HTTP APIs such as [OAuth 2.0](https://datatracker.ietf.org/doc/html/rfc6749) for authorization and [Open API](https://spec.openapis.org/oas/latest.html) for documentation. A server supporting JSON:API can support other API standards such as [OData](https://www.odata.org/) or [GraphQL](https://graphql.org/) on the same or other endpoints. + JSON:API requires use of the JSON:API media type ([`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json)) for exchanging data. From 93d316a8f8d8a189c44e8621205bda7d6acd2d07 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Thu, 31 Oct 2024 10:01:14 +0100 Subject: [PATCH 84/93] Update _format/1.2/index.md Co-authored-by: Lode Claassen --- _format/1.2/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index 708d42606..99ee5abf7 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -13,7 +13,7 @@ JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. -JSON:API can and should be combined with additional standards addressing other needs of HTTP APIs such as [OAuth 2.0](https://datatracker.ietf.org/doc/html/rfc6749) for authorization and [Open API](https://spec.openapis.org/oas/latest.html) for documentation. A server supporting JSON:API can support other API standards such as [OData](https://www.odata.org/) or [GraphQL](https://graphql.org/) on the same or other endpoints. +For additional needs of HTTP APIs, like authentication, documentation, file uploads, and more, JSON:API can and should be combined with additional standards such as [OAuth 2.0](https://datatracker.ietf.org/doc/html/rfc6749) for authorization and [Open API](https://spec.openapis.org/oas/latest.html) for documentation. It is allowed for a server supporting JSON:API to also support other API standards on the same or other endpoints, such as [OData](https://www.odata.org/) or [GraphQL](https://graphql.org/). JSON:API requires use of the JSON:API media type ([`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json)) From 5f9c8c78f15904c5d794ae485eb0e3c29276b020 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Tue, 5 Nov 2024 22:13:30 +0100 Subject: [PATCH 85/93] Update _format/1.2/index.md Co-authored-by: Dan Gebhardt --- _format/1.2/index.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index 99ee5abf7..723639d44 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -13,7 +13,11 @@ JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. -For additional needs of HTTP APIs, like authentication, documentation, file uploads, and more, JSON:API can and should be combined with additional standards such as [OAuth 2.0](https://datatracker.ietf.org/doc/html/rfc6749) for authorization and [Open API](https://spec.openapis.org/oas/latest.html) for documentation. It is allowed for a server supporting JSON:API to also support other API standards on the same or other endpoints, such as [OData](https://www.odata.org/) or [GraphQL](https://graphql.org/). +JSON:API requires use of the JSON:API media type + ([`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json)) + for exchanging data. + +> For additional needs of HTTP APIs, like authentication, documentation, file uploads, and more, JSON:API can and should be combined with additional standards such as [OAuth 2.0](https://datatracker.ietf.org/doc/html/rfc6749) for authorization and [Open API](https://spec.openapis.org/oas/latest.html) for documentation. It is allowed for a server supporting JSON:API to also support other API standards on the same or other endpoints, such as [OData](https://www.odata.org/) or [GraphQL](https://graphql.org/). JSON:API requires use of the JSON:API media type ([`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json)) From cf1494a86efed01ceece7ee3575291aac993e674 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Tue, 5 Nov 2024 22:14:46 +0100 Subject: [PATCH 86/93] remove duplicated sentence --- _format/1.2/index.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index 723639d44..9c9074980 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -19,10 +19,6 @@ JSON:API requires use of the JSON:API media type > For additional needs of HTTP APIs, like authentication, documentation, file uploads, and more, JSON:API can and should be combined with additional standards such as [OAuth 2.0](https://datatracker.ietf.org/doc/html/rfc6749) for authorization and [Open API](https://spec.openapis.org/oas/latest.html) for documentation. It is allowed for a server supporting JSON:API to also support other API standards on the same or other endpoints, such as [OData](https://www.odata.org/) or [GraphQL](https://graphql.org/). -JSON:API requires use of the JSON:API media type -([`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json)) -for exchanging data. - ## Semantics All document members, query parameters, and processing rules defined by From 8138e5e99f6e74076e8155a0ecc9086a42b0f696 Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Tue, 5 Nov 2024 22:15:51 +0100 Subject: [PATCH 87/93] remove accidentally added white spaces --- _format/1.2/index.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index 9c9074980..eba70acaf 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -1,5 +1,4 @@ ---- -version: 1.2 +---version: 1.2 status: draft --- @@ -14,8 +13,8 @@ data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. JSON:API requires use of the JSON:API media type - ([`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json)) - for exchanging data. +([`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json)) +for exchanging data. > For additional needs of HTTP APIs, like authentication, documentation, file uploads, and more, JSON:API can and should be combined with additional standards such as [OAuth 2.0](https://datatracker.ietf.org/doc/html/rfc6749) for authorization and [Open API](https://spec.openapis.org/oas/latest.html) for documentation. It is allowed for a server supporting JSON:API to also support other API standards on the same or other endpoints, such as [OData](https://www.odata.org/) or [GraphQL](https://graphql.org/). From 80c8fc6581b0dabdcfae5957733930429d67eaca Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Tue, 5 Nov 2024 22:16:21 +0100 Subject: [PATCH 88/93] fix accidentally removed line break --- _format/1.2/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index eba70acaf..1f385eeee 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -1,4 +1,5 @@ ----version: 1.2 +--- +version: 1.2 status: draft --- From d2a8086b760a311223ec1f739ad4a51e0e43e8ba Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Tue, 5 Nov 2024 22:20:34 +0100 Subject: [PATCH 89/93] break lines after 80 chars for consitency --- _format/1.2/index.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index 1f385eeee..8288fffdd 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -17,7 +17,13 @@ JSON:API requires use of the JSON:API media type ([`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json)) for exchanging data. -> For additional needs of HTTP APIs, like authentication, documentation, file uploads, and more, JSON:API can and should be combined with additional standards such as [OAuth 2.0](https://datatracker.ietf.org/doc/html/rfc6749) for authorization and [Open API](https://spec.openapis.org/oas/latest.html) for documentation. It is allowed for a server supporting JSON:API to also support other API standards on the same or other endpoints, such as [OData](https://www.odata.org/) or [GraphQL](https://graphql.org/). +> For additional needs of HTTP APIs, like authentication, documentation, file +> uploads, and more, JSON:API can and should be combined with additional +> standards such as [OAuth 2.0](https://datatracker.ietf.org/doc/html/rfc6749) +> for authorization and [Open API](https://spec.openapis.org/oas/latest.html) +> for documentation. It is allowed for a server supporting JSON:API to also +> support other API standards on the same or other endpoints, such as +> [OData](https://www.odata.org/) or [GraphQL](https://graphql.org/). ## Semantics From 77bec41695dbeb6ff3fc58dddf72ad3a5bcd89ba Mon Sep 17 00:00:00 2001 From: Jeldrik Hanschke Date: Thu, 7 Nov 2024 07:18:07 +0100 Subject: [PATCH 90/93] add example for multiple extensions applied --- _format/1.2/index.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/_format/1.2/index.md b/_format/1.2/index.md index 8288fffdd..ccb0194ab 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -93,6 +93,13 @@ values of the `ext` and `profile` parameters **MUST** equal a space-separated > specification requires that parameter values be surrounded by quotation marks > (U+0022 QUOTATION MARK, "\""). +In the following example, two extensions and one profile have been applied: + +```http +HTTP/1.1 200 OK +Content-Type: application/vnd.api+json;ext="https://example.com/version https://example.com/bulk";profile="https://example.com/resource-timestamps" +``` + #### Rules for Extensions An extension **MAY** impose additional processing rules or further restrictions From 34b97a6237621c435c964f587933142e94c984a0 Mon Sep 17 00:00:00 2001 From: Kurt McKee Date: Wed, 20 Nov 2024 08:10:39 -0600 Subject: [PATCH 91/93] Fix some typos --- _format/1.1/index.md | 8 ++++---- _format/1.2/index.md | 8 ++++---- _layouts/page.html | 2 +- examples/index.md | 4 ++-- implementations/index.md | 2 +- recommendations/index.md | 2 +- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 14eaa4f6f..0371bc107 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -2155,10 +2155,10 @@ least one of: * `id`: a unique identifier for this particular occurrence of the problem. * `links`: a [links object][links] that **MAY** contain the following members: * `about`: a [link][link] that leads to further details about this - particular occurrence of the problem. When derefenced, this URI **SHOULD** + particular occurrence of the problem. When dereferenced, this URI **SHOULD** return a human-readable description of the error. * `type`: a [link][link] that identifies the type of error that this - particular error is an instance of. This URI **SHOULD** be dereferencable to + particular error is an instance of. This URI **SHOULD** be dereferenceable to a human-readable explanation of the general error. * `status`: the HTTP status code applicable to this problem, expressed as a string value. This **SHOULD** be provided. @@ -2210,7 +2210,7 @@ parsing algorithm. The resulting value might not be a string. > as delimiters. These issues motivate the exception that JSON:API defines above. Similarly, to serialize a query parameter into a URI, an implementation **MUST** -use the [the `application/x-www-form-urlencoded` serializer](https://url.spec.whatwg.org/#concept-urlencoded-serializer), +use [the `application/x-www-form-urlencoded` serializer](https://url.spec.whatwg.org/#concept-urlencoded-serializer), with the corresponding exception that a parameter's value — but not its name — may be serialized differently than that algorithm requires, provided the serialization does not interfere with the ability to parse back the resulting URI. @@ -2247,7 +2247,7 @@ request as equivalent to one in which the square brackets were percent-encoded. [profiles]: #profiles [error details]: #errors [error object]: #error-objects -[error objects]: #errror-objects +[error objects]: #error-objects [member names]: #document-member-names [pagination]: #fetching-pagination [query parameter family]: #query-parameters-families diff --git a/_format/1.2/index.md b/_format/1.2/index.md index ccb0194ab..681ad033e 100644 --- a/_format/1.2/index.md +++ b/_format/1.2/index.md @@ -2171,10 +2171,10 @@ least one of: * `id`: a unique identifier for this particular occurrence of the problem. * `links`: a [links object][links] that **MAY** contain the following members: * `about`: a [link][link] that leads to further details about this - particular occurrence of the problem. When derefenced, this URI **SHOULD** + particular occurrence of the problem. When dereferenced, this URI **SHOULD** return a human-readable description of the error. * `type`: a [link][link] that identifies the type of error that this - particular error is an instance of. This URI **SHOULD** be dereferencable to + particular error is an instance of. This URI **SHOULD** be dereferenceable to a human-readable explanation of the general error. * `status`: the HTTP status code applicable to this problem, expressed as a string value. This **SHOULD** be provided. @@ -2226,7 +2226,7 @@ parsing algorithm. The resulting value might not be a string. > as delimiters. These issues motivate the exception that JSON:API defines above. Similarly, to serialize a query parameter into a URI, an implementation **MUST** -use the [the `application/x-www-form-urlencoded` serializer](https://url.spec.whatwg.org/#concept-urlencoded-serializer), +use [the `application/x-www-form-urlencoded` serializer](https://url.spec.whatwg.org/#concept-urlencoded-serializer), with the corresponding exception that a parameter's value — but not its name — may be serialized differently than that algorithm requires, provided the serialization does not interfere with the ability to parse back the resulting URI. @@ -2263,7 +2263,7 @@ request as equivalent to one in which the square brackets were percent-encoded. [profiles]: #profiles [error details]: #errors [error object]: #error-objects -[error objects]: #errror-objects +[error objects]: #error-objects [member names]: #document-member-names [pagination]: #fetching-pagination [query parameter family]: #query-parameters-families diff --git a/_layouts/page.html b/_layouts/page.html index 6555a979c..acd1e512c 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -47,7 +47,7 @@

A specification for building APIs in JSON