plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

DiscoveryEntry

DiscoveryEntry

One resource this API exposes: where it lives, what it is called in the permission system, which schemas describe it and which operations it registers.

View as Markdown
Summary view
DiscoveryEntryList, 7 fields. What a list returns by default.
Detail view
DiscoveryEntry, 7 fields. The default for a single read and for every write.

Used by

GETList the resources this API exposes/DiscoveryEntryList

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
namestring

Human-readable name of the resource collection.

pathstring or null

Absolute URL of the collection endpoint, or null where this resource registers no flat collection and is reached only through a parent or by id.

item_pathstring or null

Templated absolute URL of the single-resource endpoint, with the path parameter left as a {placeholder}. Null where the resource has no flat route at all.

permission_prefixstring

The permission prefix this resource is gated on. It is the value after the class in an api:{class}:{prefix} token ability.

summary_schemastring

JSON pointer to the OpenAPI component describing this resource in the summary view, which is what a collection returns by default.

detail_schemastring

JSON pointer to the OpenAPI component describing the detail view, which is what a single-resource read and every write return.

operationsarray of string

The operations this resource registers, as index, store, show, update, destroy and actions.{verb}. A nested operation keeps its full identifier, so work-items.comments.index appears verbatim.

Variants

DiscoveryEntryList 7 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.