Frontend | Backend | Api

Documentation routes (Frontend)

Name Request Response variables Description
showModel

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

module [A-Z][a-zA-Z]+
model [A-Z][a-zA-Z]+
abstraction [A-Z][a-zA-Z]+
Name Type Description
abstraction string Current abstraction
currentModule string Current module
currentModel string Current module
modules array Array with documented modules
root Page Root page
Show a page documenting a model
showModel

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

module [A-Z][a-zA-Z]+
model [A-Z][a-zA-Z]+
abstraction [A-Z][a-zA-Z]+
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Add a comment to a page
showModel

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

module [A-Z][a-zA-Z]+
model [A-Z][a-zA-Z]+
abstraction [A-Z][a-zA-Z]+
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Change an existing comment
showRoutes

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

abstraction [A-Z][a-zA-Z]+
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Add a comment to a page
showRoutes

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

abstraction [A-Z][a-zA-Z]+
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Change an existing comment
showTemplates

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

abstraction [A-Z][a-zA-Z]+
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Add a comment to a page
showTemplates

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

abstraction [A-Z][a-zA-Z]+
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Change an existing comment
showClass

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

class [A-Z][a-zA-Z]+(\\[A-Z][a-zA-Z]+)*
abstraction [A-Z][a-zA-Z]+
model [A-Z][a-zA-Z]+(\\[A-Z][a-zA-Z]+)*
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Add a comment to a page
showClass

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

class [A-Z][a-zA-Z]+(\\[A-Z][a-zA-Z]+)*
abstraction [A-Z][a-zA-Z]+
model [A-Z][a-zA-Z]+(\\[A-Z][a-zA-Z]+)*
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Change an existing comment
showGlobalHomepage

GET /docs/global
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Show the page
showGlobalHomepage

POST /docs/global
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Add a comment to a page
showGlobalHomepage

PUT /docs/global
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Change an existing comment
showGlobalPage

GET /docs/global/{slug}

slug .*
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Show the page
showGlobalPage

POST /docs/global/{slug}

slug .*
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Add a comment to a page
showGlobalPage

PUT /docs/global/{slug}

slug .*
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Change an existing comment
showPage

GET /docs/page/{slug}

slug .*
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Show the page
showPage

POST /docs/page/{slug}

slug .*
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Add a comment to a page
showPage

PUT /docs/page/{slug}

slug .*
Name Type Description
modules array Array with documented modules
abstraction string Current abstraction
page Page Page that is displayed
Change an existing comment