Commit a6f230f3 authored by Roensby's avatar Roensby Committed by Gabe Sullice
Browse files

Issue #3051908 by Roensby, gabesullice: Documentation in json.api.php...

Issue #3051908 by Roensby, gabesullice: Documentation in json.api.php describes wrong query parameter
parent 52534b23
Loading
Loading
Loading
Loading
+4 −4
Original line number Diff line number Diff line
@@ -84,7 +84,7 @@ use Drupal\Core\Access\AccessResult;
 *              version-identifier
 *                    __|__
 *                   /     \
 * ?resource_version=foo:bar
 * ?resourceVersion=foo:bar
 *                   \_/ \_/
 *                    |   |
 *    version-negotiator  |
@@ -105,14 +105,14 @@ use Drupal\Core\Access\AccessResult;
 * that has a "Published" revision and a subsequent "Draft" revision.
 *
 * Using JSON:API, one could request the "Published" node by requesting
 * `/jsonapi/node/page/{{uuid}}?resource_version=rel:latest-version`.
 * `/jsonapi/node/page/{{uuid}}?resourceVersion=rel:latest-version`.
 *
 * To preview an entity that is still a work-in-progress (i.e. the "Draft"
 * revision) one could request
 * `/jsonapi/node/page/{{uuid}}?resource_version=rel:working-copy`.
 * `/jsonapi/node/page/{{uuid}}?resourceVersion=rel:working-copy`.
 *
 * To request a specific revision ID, one can request
 * `/jsonapi/node/page/{{uuid}}?resource_version=id:{{revision_id}}`.
 * `/jsonapi/node/page/{{uuid}}?resourceVersion=id:{{revision_id}}`.
 *
 * It is not yet possible to request a collection of revisions. This is still
 * under development in issue [#3009588].