Liking cljdoc? Tell your friends :D

clj-docker-client.specs


->endpointclj

(->endpoint definition)

{path {req-method1 {meta-data..}} req-method2 {meta-data..} ...} -> {:path path :ops [output-of->op]}

{path {req-method1 {meta-data..}}
req-method2 {meta-data..}
...} -> {:path path :ops [output-of->op]}
sourceraw docstring

->opclj

(->op desc)

{req-method1 {summary summary operationId id ...}} -> {method1 :req-method1 op :op doc doc params [params]}

{req-method1 {summary     summary
operationId id
...}} -> {method1 :req-method1
          op      :op
          doc     doc
          params  [params]}
sourceraw docstring

fetch-specclj

(fetch-spec)
(fetch-spec version)

Returns the spec for the Docker API for the supplied version.

Pass nil for the latest spec.

Returns the spec for the Docker API for the supplied version.

Pass nil for the latest spec.
sourceraw docstring

find-op-metaclj

(find-op-meta op ops)

Finds the matching operation by operationId in list of ops from the spec.

Returns the method, doc and params form it, nil otherwise.

Finds the matching operation by operationId in list of ops from the spec.

Returns the method, doc and params form it, nil otherwise.
sourceraw docstring

gather-request-paramsclj

(gather-request-params supplied-params request-params {:keys [name in]})

Reducer fn generating categorized params from supplied params.

Returns a map of query, path and body params.

Reducer fn generating categorized params from supplied params.

Returns a map of query, path and body params.
sourceraw docstring

get-paths-of-categoryclj

(get-paths-of-category category version)

Fetches the paths section of the swagger.yaml and the version.

Filters paths starting with the specified category.

Fetches the paths section of the swagger.yaml and the version.

Filters paths starting with the specified category.
sourceraw docstring

request-info-ofclj

(request-info-of category op version)

Returns a map of path, method, doc and params of an op of a category.

Prefixes the paths with the version from spec.

Returns nil if not found.

Returns a map of path, method, doc and params of an op of a category.

Prefixes the paths with the version from spec.

Returns nil if not found.
sourceraw docstring

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

× close