oc.lib.hateoas

Liking cljdoc? Tell your friends :D

All platforms.

Namespace of helpers for creating HATEOAS links.

Namespace of helpers for creating HATEOAS links.

raw docstring

add-link^clj/s

(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.

source raw docstring

archive-link^clj/s

(archive-link url)

(archive-link url others)

Link to archive an existing resource.

Link to archive an existing resource.

source raw docstring

collection-link^clj/s

(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.

source raw docstring

create-link^clj/s

(create-link url media-type)

(create-link url media-type others)

Link to create a new resource.

Link to create a new resource.

source raw docstring

DELETE^clj/s

source

delete-link^clj/s

(delete-link url)

(delete-link url others)

Link to delete an existing resource.

Link to delete an existing resource.

source raw docstring

item-link^clj/s

(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.

source raw docstring

json-collection-version^clj/s

source

link-for^clj/s

(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^clj/s

(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.

source raw docstring

link-replace-href^clj/s

(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.

source raw docstring

OPTIONS^clj/s

source

partial-update-link^clj/s

(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.

source raw docstring

PATCH^clj/s

source

POST^clj/s

source

PUT^clj/s

source

remove-link^clj/s

(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.

source raw docstring

self-link^clj/s

(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.

source raw docstring

up-link^clj/s

(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.

source raw docstring

update-link^clj/s

(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.

source raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts

`Ctrl`+`k`	Jump to recent docs
`←`	Move to previous article
`→`	Move to next article
`Ctrl`+`/`	Jump to the search field

Raise an issue Browse cljdoc source Chat on Slack

× close

oc.lib.hateoas

add-linkclj/s

archive-linkclj/s

collection-linkclj/s

create-linkclj/s

DELETEclj/s

delete-linkclj/s

GETclj/s

HEADclj/s

http-methodsclj/s

item-linkclj/s

json-collection-versionclj/s

link-forclj/s

link-mapclj/s

link-replace-hrefclj/s

OPTIONSclj/s

partial-update-linkclj/s

PATCHclj/s

POSTclj/s

PUTclj/s

remove-linkclj/s

self-linkclj/s

up-linkclj/s

update-linkclj/s

add-link^clj/s

archive-link^clj/s

collection-link^clj/s

create-link^clj/s

DELETE^clj/s

delete-link^clj/s

GET^clj/s

HEAD^clj/s

http-methods^clj/s

item-link^clj/s

json-collection-version^clj/s

link-for^clj/s

link-map^clj/s

link-replace-href^clj/s

OPTIONS^clj/s

partial-update-link^clj/s

PATCH^clj/s

POST^clj/s

PUT^clj/s

remove-link^clj/s

self-link^clj/s

up-link^clj/s

update-link^clj/s