package sihl

  1. Overview
  2. Docs
The Sihl web framework

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (35)

Authors

  1. J
    Josef Erben
  2. A
    Aron Erben
  3. M
    Miko Nieminen

Maintainers

  1. J
    josef@oxidizing.io

Sources

3.0.4.tar.gz
md5=8a2754d6e5b9eafb8ff332abdb1ceb7d
sha512=3230a1315686b0b6f90a41ceda27ab036e178184ab13d5a98f64d6d987caf4a8a5d94ed78bc8e79b0ee3b40ccbb1dbdc71ffe171f1aef1f18aba81fc720e3a1b

doc/sihl/Sihl/Web/Rest/module-type-CONTROLLER/index.html

Module type Rest.CONTROLLERSource

A module of type CONTROLLER can be used to create a resource with resource_of_controller. Use a controller instead of a service and a view if you need low level control.

Sourcetype t

t is the type of the resource.

Sourceval index : string -> Request.t -> Response.t Lwt.t

index name request returns a list of all resource instances as a response.

name is the name of the resource in plural, for example orders or users.

Sourceval new' : ?key:string -> string -> Request.t -> Response.t Lwt.t

new' ?key name request returns a form to create instances of the resource as a response.

name is the name of the resource in plural, for example orders or users.

The form data is stored in the flash storage under the key. By default, the value is _form.

Sourceval create : string -> ('a, 'b, t) Conformist.t -> Request.t -> Response.t Lwt.t

create name schema request handles the creation of new resource instances and returns the creation result as a response.

name is the name of the resource in plural, for example orders or users.

Sourceval show : string -> Request.t -> Response.t Lwt.t

show name request returns a single resource instance as a response.

name is the name of the resource in plural, for example orders or users.

Sourceval edit : ?key:string -> string -> Request.t -> Response.t Lwt.t

edit ?key name request returns a form to edit resource instances as a response.

name is the name of the resource in plural, for example orders or users.

The form data is stored in the flash storage under the key. By default, the value is _form.

Sourceval update : string -> ('a, 'b, t) Conformist.t -> Request.t -> Response.t Lwt.t

update name schema request handles the update of a resource instance and returns the update result as a response.

name is the name of the resource in plural, for example orders or users.

Sourceval delete' : string -> Request.t -> Response.t Lwt.t

delete name request handles the deletion of a resource instance and returns the deletion result as a response.

name is the name of the resource in plural, for example orders or users.