Module jaywalker_resource

Jaywalker resource provides a limited interface to jiak object linkwalking over HTTP.

Authors: Bryan Fink (bryan@basho.com).

Description

Jaywalker resource provides a limited interface to jiak object linkwalking over HTTP. The interface exposed is:

/jaywalker/Bucket/Key[/b,t,acc]

where:

Bucket/Key tells jaywalker where to start

each /b,t,acc segment is a request to follow some links

b is a filter on buckets t is a filter on tags acc is whether or not to return the objects from that step

each of b,t,acc may be underscore, to signify wildcard

acc is by default '0' (do not return these objects), except for the final /b,t,acc segment, for which it is by default '1' (return the objects)

Return from jaywalker resource is a JSON object with one field, "results", which is a list of lists. Each lists in "results" is the list of results from the corresponding step in the query.

so:

/jaywalker/foo/123/bar,_,_ : returns all bar objects attached to foo 123 {results: [[bar1, bar2, ...]]}

/jaywalker/foo/123/bar,_,1/_,_,_ : returns all bar objects attached to foo 123, and all objects attached to those bar objects {results: [[bar1, bar2, ...], [baz1, quux2, ...]]}

Function Index

allowed_methods/2
content_types_provided/2
expires/2
init/1
is_authorized/2
ping/2
process_post/2
resource_exists/2
to_json/2

Function Details

allowed_methods/2

allowed_methods(RD, Ctx) -> any()

content_types_provided/2

content_types_provided(RD, Ctx) -> any()

expires/2

expires(RD, Ctx) -> any()

init/1

init(Props) -> any()

is_authorized/2

is_authorized(RD, Ctx) -> any()

ping/2

ping(ReqData, State) -> any()

process_post/2

process_post(RD, Ctx) -> any()

resource_exists/2

resource_exists(RD, Ctx) -> any()

to_json/2

to_json(RD, Ctx) -> any()


Generated by EDoc, Jan 29 2010, 10:11:59.