☰ Browse the reference

Routes·Documentation module

Documentation routes

URLs the Documentation module answers, their parameters and the variables each view receives.

View Public site URLs and what their templates receive.

Templates view

GET /docs/module/{module}/model/{model}/{abstraction} showModel

Show a page documenting a model

Path parameters module matches [A-Z][a-zA-Z]+model matches [A-Z][a-zA-Z]+abstraction matches [A-Z][a-zA-Z]+

The template receives

Variable	Type	Description
$abstraction	string	Current abstraction
$abstractions	array	Model documentation for every abstraction, keyed Frontend, Api, Backend
$currentModule	string	Current module
$currentModel	string	Current module
$modules	array	Array with documented modules
$root	Page	Root page

Common variables such as $_url, $_request and $_menu are available too. Global template variables

POST /docs/module/{module}/model/{model}/{abstraction} showModel

Add a comment to a page

Path parameters module matches [A-Z][a-zA-Z]+model matches [A-Z][a-zA-Z]+abstraction matches [A-Z][a-zA-Z]+

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

PUT /docs/module/{module}/model/{model}/{abstraction} showModel

Change an existing comment

Path parameters module matches [A-Z][a-zA-Z]+model matches [A-Z][a-zA-Z]+abstraction matches [A-Z][a-zA-Z]+

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

POST /docs/module/{module}/routes/{abstraction} showRoutes

Add a comment to a page

Path parameters abstraction matches [A-Z][a-zA-Z]+

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

PUT /docs/module/{module}/routes/{abstraction} showRoutes

Change an existing comment

Path parameters abstraction matches [A-Z][a-zA-Z]+

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

POST /docs/module/{module}/templates/{abstraction} showTemplates

Add a comment to a page

Path parameters abstraction matches [A-Z][a-zA-Z]+

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

PUT /docs/module/{module}/templates/{abstraction} showTemplates

Change an existing comment

Path parameters abstraction matches [A-Z][a-zA-Z]+

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

POST /docs/class/{class}/{abstraction}/{model} showClass

Add a comment to a page

Path parameters class matches [A-Z][a-zA-Z]+(\\[A-Z][a-zA-Z]+)*abstraction matches [A-Z][a-zA-Z]+model matches [A-Z][a-zA-Z]+(\\[A-Z][a-zA-Z]+)*

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

PUT /docs/class/{class}/{abstraction}/{model} showClass

Change an existing comment

Path parameters class matches [A-Z][a-zA-Z]+(\\[A-Z][a-zA-Z]+)*abstraction matches [A-Z][a-zA-Z]+model matches [A-Z][a-zA-Z]+(\\[A-Z][a-zA-Z]+)*

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

GET /docs/global/{fullSlug} showGlobalPage

Show the page

Path parameters fullSlug matches .*

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

POST /docs/global/{fullSlug} showGlobalPage

Add a comment to a page

Path parameters fullSlug matches .*

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

PUT /docs/global/{fullSlug} showGlobalPage

Change an existing comment

Path parameters fullSlug matches .*

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

GET /docs/page/{fullSlug} showPage

Show the page

Path parameters fullSlug matches .*

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

POST /docs/page/{fullSlug} showPage

Add a comment to a page

Path parameters fullSlug matches .*

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

PUT /docs/page/{fullSlug} showPage

Change an existing comment

Path parameters fullSlug matches .*

The template receives

Variable	Type	Description
$modules	array	Array with documented modules
$abstraction	string	Current abstraction
$page	Page	Page that is displayed

Common variables such as $_url, $_request and $_menu are available too. Global template variables

Only GET routes list their variables.