resp looks like.
https://devstore.rerum.io/v1/id/11111
+ | Pattern | +Payload | +Response | +
|---|---|---|
/id/_id/expanded |
+ empty |
+ 200 {JSON} |
+
+ Gather every current Annotation targeting the record and merge what those Annotations assert onto it.
+ This does the entity assembly that client applications otherwise perform with many
+ /query requests.
+
_id—the id of the record in
+ RERUM.?generator—optional. Only
+ expand with Annotations generated by this registered app agent. Both the
+ http and
+ https spellings of the URI are matched.?creator—optional. Only
+ expand with Annotations attributed to this creator.?limit and
+ ?skip—optional. Page the
+ Annotation search. limit defaults to 200.{JSON}—The record
+ with identifier _id, plus the merged
+ properties.Annotations-Merged—how many
+ Annotations went into this expansion. When it equals your
+ limit there may be more, and the record you
+ received was expanded from only part of its Annotations. Raise the
+ limit or walk pages with
+ skip.+ Only the current (leaf) versions of Annotations are gathered. No token is required. + The response is a raw assembly—if your application needs the data in a particular shape, format the + response for your own internal needs. +
+body and
+ bodyValue are read. Every other property of
+ the Annotation is ignored, and an Annotation carrying neither is ignored entirely.body with exactly one property contributes
+ that property. Values are passed through exactly as they appear—a body of
+ {"text": {"value": "hello"}} puts
+ {"value": "hello"} on the entity, not
+ "hello".bodyValue string, and a
+ TextualBody body, both land under the property
+ bodyValue. The
+ TextualBody is kept whole so its
+ format and
+ language survive.@id,
+ id,
+ _id,
+ __rerum,
+ __deleted, and
+ @context. An assertion naming
+ __proto__ is dropped for the same reason—it
+ is not data, and emitting it would hand a prototype pollution vector to every client that parses the
+ response.body with
+ more than one property, an Annotation with multiple bodies, the
+ Choice,
+ Composite, and
+ List constructs, and a
+ body that is a URI referencing an external
+ resource.+
+ const expanded = await fetch("https://devstore.rerum.io/v1/id/11111/expanded").then(resp => resp.json()).catch(err => {throw err})
+
+ This can be used directly in the browser. Try it to see what the response resp looks like.
+ https://devstore.rerum.io/v1/id/11111/expanded
+
| Pattern | +Payload | +Response | +
|---|---|---|
/id/_id/expanded |
+ {JSON} |
+ 200 {JSON} |
+
+ The same expansion as
+ GET /id/_id/expanded,
+ with the search for Annotations narrowed by the request body. Use this when the convenience parameters on
+ the GET are not enough. Unlike the GET, this response is not browser cached.
+
{JSON}—an object of
+ literal properties combined into the search for Annotations targeting the record. The property names are
+ the real ones stored on an Annotation, so filtering by generating application means supplying
+ __rerum.generatedBy. An empty or absent body
+ expands without any filter.?generator and
+ ?creator parameters of the GET have no effect
+ here—supply them in the body instead. Paging is not a filter, so
+ ?limit and
+ ?skip still work, and the
+ Annotations-Merged response header is set
+ exactly as it is on the GET.__rerum.generatedBy and
+ creator are matched against both the
+ http and
+ https spellings of the URI you provide. Every
+ other property is applied exactly as supplied.Content-Type header must be
+ application/json. A body that is not a JSON
+ object is a 400.+ Three constraints belong to the endpoint and cannot be overruled. Supplying them is not an error—they are + ignored, by exact name or as a dotted prefix. +
+| Ignored | +Always applied instead | +
|---|---|
target,
+ target.@id,
+ target.id,
+ target.source,
+ target.source.@id,
+ target.source.id |
+ Annotations targeting the record at
+ _id, including those
+ targeting it through a
+ SpecificResource or through a
+ fragment of its URI such as
+ #xywh=0,0,100,100 |
+
type,
+ @type |
+ Annotations only | +
__rerum.history.next,
+ __rerum.history.previous,
+ __rerum.history.prime |
+ Current (leaf) versions only | +
+
+ const expanded = await fetch("https://devstore.rerum.io/v1/id/11111/expanded", {
+ method: "POST",
+ headers: { "Content-Type": "application/json" },
+ body: JSON.stringify({
+ "__rerum.generatedBy": "https://devstore.rerum.io/v1/id/agent7",
+ "motivation": "describing"
+ })
+ }).then(resp => resp.json()).catch(err => {throw err})
+ This section is non-normative.
diff --git a/routes/id.js b/routes/id.js index fdfca44f..3e2069a1 100644 --- a/routes/id.js +++ b/routes/id.js @@ -2,6 +2,15 @@ import express from 'express' const router = express.Router() //This controller will handle all MongoDB interactions. import controller from '../db-controller.js' +import rest from '../rest.js' + +router.route('/:_id/expanded') + .get(controller.idExpanded) + .post(rest.verifyJsonContentType, controller.idExpanded) + .all((req, res, next) => { + res.statusMessage = 'Improper request method, please use GET or POST.' + res.status(405).end() + }) router.route('/:_id') .get(controller.id)