Ring-swagger Api Documentation

Version: 0.22.3

ring.swagger.json-schema

->FieldSchema

(->FieldSchema schema)

Positional factory function for class ring.swagger.json_schema.FieldSchema.

->swagger

(->swagger x)(->swagger x options)

additional-properties

(additional-properties schema)

Generates json-schema additional properties from a plain map schema from under key s/Keyword.

assoc-collection-format

(assoc-collection-format m options)

Add collectionFormat to the JSON Schema if the parameter type is query or formData.

convert-class

multimethod

describe

(describe schema desc & kvs)

Attach description and possibly other meta-data to a schema.

field

(field schema meta-data)

Attaches meta-data to a schema under :json-schema key. If the schema is of type which cannot have meta-data (e.g. Java Classes) schema is wrapped first into s/conditional Schema.

json-schema-meta

(json-schema-meta schema)

Select interesting keys from meta-data of schema.

JsonSchema

protocol

members

convert

(convert this options)

map->FieldSchema

(map->FieldSchema m__6289__auto__)

Factory function for class ring.swagger.json_schema.FieldSchema, taking a map of keywords to field values.

merge-meta

(merge-meta m x {no-meta :ring.swagger.json-schema/no-meta, key-meta :key-meta})

not-supported!

(not-supported! e)

properties

(properties schema)

Take a map schema and turn them into json-schema properties. The result is put into collection of same type as input schema. Thus linked/map should keep the order of items. Returnes nil if no properties are found.

reference

(reference e)