Module mod_ocs_rest

This is an httpd callback module handling HTTP GET operations. The HTTP resources are managed in modules named ocs_rest_res_*.

Resource Handler Functions

The resource handler modules should implement callback functions in the pattern described in the example below.

get_<Collection>/2

get_<Collection>(Query, Headers) -> Result

Query = [{Param, Value}]
Param = string()
Value = string()
Headers = [{Option, Value}
Option = accept_ranges | allow | cache_control | content_MD5 | content_encoding | content_language | content_length | content_location | content_range | content_type | date | etag | expires | last_modified | location | pragma | retry_after | server | trailer | transfer_encoding
Result = {ok, Headers, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem} | {error, StatusCode, ResponseHeaders, ResponseBody}}
ResponseBody = io_list()
StatusCode = 200..599
ResponseHeaders = [{Option, Value}
Problem = #{type := uri(), title := string(), code := string(), cause => string(), detail => string(), invalidParams => [#{param := string(), reason => string()}], status => 400..599}

Response Headers must include content_type if ResponseBody is not en empty list. An optional Problem report may be provided in error responses which shall be formatted by format_problem/2 and included in the response body.

get_<Resource>/2

get_<Resource>(Id, Query, [Headers, ...]) -> Result

Id = string()
Query = [{Param, Value}]
Param = string()
Value = string()
Headers = [{Option, Value}
Option = accept_ranges | allow | cache_control | content_MD5 | content_encoding | content_language | content_length | content_location | content_range | content_type | date | etag | expires | last_modified | location | pragma | retry_after | server | trailer | transfer_encoding
Result = {ok, Headers, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem} | {error, StatusCode, ResponseHeaders, ResponseBody}}
ResponseBody = io_list()
StatusCode = 200..599
ResponseHeaders = [{Option, Value}
Problem = #{type := uri(), title := string(), code := string(), cause => string(), detail => string(), invalidParams => [#{param := string(), reason => string()}], status => 200..599}

Function Index

Function Details

do/1

do(ModData) -> Result

ModData = #mod{}
Result = {proceed, OldData} | {proceed, NewData} | {break, NewData} | done
OldData = list()
NewData = [{response, {StatusCode, Body}}] | [{response, {response, Head, Body}}] | [{response, {already_sent, StatusCode, Size}}]
StatusCode = integer()
Body = list() | nobody | {Fun, Arg}
Head = [HeaderOption]
HeaderOption = {Option, Value} | {code, StatusCode}
Option = accept_ranges | allow | cache_control | content_MD5 | content_encoding | content_language | content_length | content_location | content_range | content_type | date | etag | expires | last_modified | location | pragma | retry_after | server | trailer | transfer_encoding
Value = string()
Size = term()
Fun = fun((Arg) -> sent | close | Body)
Arg = [term()]