Liking cljdoc? Tell your friends :D

spec-tools.swagger.core


accept-specclj/smultimethod


create-or-raise-refsclj/smultimethod


expandclj/smultimethod


expand-qualified-keywordsclj/s

(expand-qualified-keywords x options)

extract-parameterclj/smultimethod


swagger-specclj/s

(swagger-spec x)
(swagger-spec x options)

Transforms data into a swagger2 spec. Input data must conform to the Swagger2 Spec (https://swagger.io/specification/v2/) with a exception that it can have any qualified keywords that are expanded with the spec-tools.swagger.core/expand multimethod.

Available options:

KeyDescription
:refs?Whether refs should be created for objects. Default: false
:default-titles?Whether to automatically include titles. Default: true
Transforms data into a swagger2 spec. Input data must conform
to the Swagger2 Spec (https://swagger.io/specification/v2/) with a
exception that it can have any qualified keywords that are expanded
with the `spec-tools.swagger.core/expand` multimethod.

Available options:

| Key                | Description
|--------------------|-----------------------------------------------------------
| `:refs?`           | Whether refs should be created for objects. Default: false
| `:default-titles?` | Whether to automatically include titles. Default: true
raw docstring

transformclj/s

(transform spec)
(transform spec options)

Generate Swagger schema matching the given clojure.spec spec.

Since clojure.spec is more expressive than Swagger schemas, everything that satisfies the spec should satisfy the resulting schema, but the converse is not true.

Available options:

KeyDescription
:refs?Whether refs should be created for objects. Default: false
:default-titles?Whether to automatically include titles. Default: true
Generate Swagger schema matching the given clojure.spec spec.

Since clojure.spec is more expressive than Swagger schemas, everything that
satisfies the spec should satisfy the resulting schema, but the converse is
not true.

Available options:

| Key                | Description
|--------------------|-----------------------------------------------------------
| `:refs?`           | Whether refs should be created for objects. Default: false
| `:default-titles?` | Whether to automatically include titles. Default: true
raw docstring

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

× close