Previous topic

Design and Conventions

Next topic

API Documentation

This Page

GlossaryΒΆ

collection name
The plural name of a resource. E.g users.
collection resource
A resource where several instances of its type can exist and need a unique ID in the system to be identified.
marker
A portion of the URL which will be dynamically matched, declared with the syntax {marker}.
member name
The singular name of a resource. E.g: user.
named routes
A defined route in your application that has a unique (within your routes map) name you can use to refer to.
nested resource
A resource that has parents. Like bookmarks in users/2/bookmarks.
root resource
A top level resource that does not have a parent.
singular resource
A singleton resource within its parent scope (does not need to be identified by an ID) E.g users/3/profile in case a user has a single profile.