"routers" parameter for queries

[gsteel]

Apparently, you can provide a routers query parameter to the API and it will "resolve" urls for documents and links with this information on the server returning the urls in the payload.

This means that all types would possibly contain a top-level url property and url may also be present in links that have Document type.

The documentation is pretty scant:

• https://prismic.io/docs/core-concepts/link-resolver-route-resolver#route-resolver

… but it looks like you can provide router config during initialisation and then reuse the config for every request thereafter. I assume that the config will be included in the meta-data payload as default options for the forms property.

Currently, it looks like routers should be specified as a JSON array of objects, something like this:

let routers = [
    {
        "type": "my-type", // Name of document type
        "path": "/products/:range/:category/:uid", // Where ":category" is the UID of the linked category document and ":range" is the UID of the grandparent category.range document
        "resolvers": {
            "category": "parent-category", // Top-level content relationship to a "category" type where "parent-category" is the property name of "my-type"
            "range": "category.range" // "range" is a property of "category" in this example being a content-relationship to a range document.
        }
    },
    {
        "type": "blog-post",
        "path": "/:lang/blog/:uid" // :lang is the document locale ie 'en-gb'
    },
    // Not yet known whether other types/properties are feasible such as
    {
        "type": "whatever",
        "path": "/:id/:date-published/:tags" // <- Who knows?
    }
];

[gsteel]

Result sets over multiple pages from queries where the routes parameter has been provided do not include the route configuration in the URLs for the next and previous pages. This makes those URLs effectively useless.

[gsteel]

Generic document properties that definitely do not work as route url parameters:

• type
• id
• date
• href
• first_publication_date
• last_publication_date

It looks like only lang and uid are supported on the root document, and only uid on linked documents.