Liking cljdoc? Tell your friends :D

oc.lib.hateoas

Namespace of helpers for creating HATEOAS links.

Namespace of helpers for creating HATEOAS links.
raw docstring

(add-link method url media-type)
(add-link method url media-type others)

Link to add an existing item to a collection.

Link to add an existing item to a collection.
sourceraw docstring

(archive-link url)
(archive-link url others)

Link to archive an existing resource.

Link to archive an existing resource.
sourceraw docstring

(collection-link url media-type)
(collection-link url media-type others)

Link that points to a collection (list) of items.

Link that points to a collection (list) of items.
sourceraw docstring

(create-link url media-type)
(create-link url media-type others)

Link to create a new resource.

Link to create a new resource.
sourceraw docstring

DELETEclj/s

source

(delete-link url)
(delete-link url others)

Link to delete an existing resource.

Link to delete an existing resource.
sourceraw docstring

GETclj/s

source

source

http-methodsclj/s

source

(item-link url media-type)
(item-link url media-type others)

Link that points to an individual item in a collection.

Link that points to an individual item in a collection.
sourceraw docstring

json-collection-versionclj/s

source

(link-for & rest)
(link-for links :guard sequential? rel :guard string?)
(link-for links
          :guard
          sequential?
          rels
          :guard
          sequential?
          methods
          :guard
          sequential?)
(link-for links
          :guard
          sequential?
          rels
          :guard
          sequential?
          method
          :guard
          string?)
(link-for links
          :guard
          sequential?
          rel
          :guard
          string?
          methods
          :guard
          sequential?)
(link-for links :guard sequential? rel :guard string? params :guard nil-or-map?)
(link-for links :guard sequential? rel :guard string? method :guard string?)
(link-for links
          :guard
          sequential?
          rels
          :guard
          sequential?
          methods
          :guard
          sequential?
          params
          :guard
          nil-or-map?)
(link-for links
          :guard
          sequential?
          rels
          :guard
          sequential?
          method
          :guard
          string?
          params
          :guard
          nil-or-map?)
(link-for links
          :guard
          sequential?
          rel
          :guard
          string?
          methods
          :guard
          sequential?
          params
          :guard
          nil-or-map?)
(link-for links
          :guard
          sequential?
          rel
          :guard
          string?
          params
          :guard
          nil-or-map?
          replacements
          :guard
          map?)
(link-for links
          :guard
          sequential?
          rel
          :guard
          string?
          method
          :guard
          string?
          params
          :guard
          nil-or-map?)
(link-for links
          :guard
          sequential?
          rels
          :guard
          sequential?
          methods
          :guard
          sequential?
          params
          :guard
          nil-or-map?
          replacements
          :guard
          map?)
(link-for links
          :guard
          sequential?
          rels
          :guard
          sequential?
          method
          :guard
          string?
          params
          :guard
          nil-or-map?
          replacements
          :guard
          map?)
(link-for links
          :guard
          sequential?
          rel
          :guard
          string?
          methods
          :guard
          sequential?
          params
          :guard
          nil-or-map?
          replacements
          :guard
          map?)
(link-for links
          :guard
          sequential?
          rel
          :guard
          string?
          method
          :guard
          string?
          params
          :guard
          nil-or-map?
          replacements
          :guard
          map?)
source

(link-map rel method url media-types)
(link-map rel method url media-types others)

Create a HATEOAS link for the specified relation, HTTP method, URL, and media-type.

Any additional key/values will be included as additional properties of the link.

Create a HATEOAS link for the specified relation, HTTP method, URL, and media-type.

Any additional key/values will be included as additional properties of the link.
sourceraw docstring

(link-replace-href link replacements)

Given a link with an :href and a :replace map, and given a replacements map, apply the replacements to the link.

Given a link with an :href and a :replace map,
and given a replacements map, apply the replacements to the link.
sourceraw docstring

OPTIONSclj/s

source

(partial-update-link url media-types)
(partial-update-link url media-types others)

Link to update an existing resource with a fragment of content that's merged into the existing content.

Link to update an existing resource with a fragment of content that's merged into the existing content.
sourceraw docstring

PATCHclj/s

source

POSTclj/s

source

PUTclj/s

source

(remove-link url)
(remove-link url media-type)
(remove-link url media-type others)

Link to remove an item from a collection.

Link to remove an item from a collection.
sourceraw docstring

(self-link url media-type)
(self-link url media-type others)

Link that points back to the resource itself.

Link that points back to the resource itself.
sourceraw docstring

(up-link url media-type)
(up-link url media-type others)

Link that points to the parent collection that contains this item.

Link that points to the parent collection that contains this item.
sourceraw docstring

(update-link url media-types)
(update-link url media-types others)

Link to replace an existing resource with new content.

Link to replace an existing resource with new content.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close