| Class |
Description |
|
ActionAnnotations
|
Reads the OpenAPI annotations an application declares on a controller and its actions, so that
what is derived from the URL mappings can be corrected or enriched. |
|
BaseDocument
|
The document a description starts from, which describes the API as a whole and what the
application does not map itself. |
|
ComponentSchemas
|
The schemas a document holds in its components: resolved from classes through swagger-core,
derived from them, such as a patch, and named so that no two share a name. |
|
ControllerCatalog
|
The controllers of an application, as a description reads them: by the name and namespace a
mapping reaches them by, and by what they serve. |
|
DocumentCompletion
|
Completes a document once every operation is described: each operation gets an identifier of
its own, the tags the operations use are described, and nothing refers to a schema the document
does not have. |
|
DocumentParts
|
Describes one part of a document at a time, so an application does not lose its whole
description because one class cannot be introspected. |
|
ErrorsViews
|
The views that render the validation errors in JSON, looked up the way JSON views looks them up
when it renders them. |
|
GrailsModelConverter
|
Teaches swagger-core what a Groovy class, a command object and a GORM entity look like, so the
schema of such a type is right wherever it is resolved: as a resource, as a command object, or
as the implementation an annotation names. |
|
JsonErrorsViews
|
The errors views of JSON views, only loaded where JSON views is present. |
|
MappingVersions
|
The versions URL mappings are declared for, which Grails matches on the Accept-Version
header a request sends. |
|
MediaTypes
|
The media types an action responds in and binds a body from, as the formats its controller
declares map to them. |
|
OperationParameters
|
The parameters of an operation: the variables of its path, the request parameters its action
binds by name or through a command object, the paging of a listing, and the version asked for. |
|
OperationResponses
|
The responses an operation is described with: those a RestfulController action answers with,
or success, and a miss for an operation addressing a resource. |
|
PropertyNames
|
The names the properties of a type Grails renders and binds are described under. |
|
RestfulControllerActions
|
The shape of the actions RestfulController declares, used to describe a
controller reached through the default {- code:
- "/$controller/$action?
|
|
SchemaNames
|
Keeps each schema name in a document to one thing. |
|
SchemaReferences
|
Moves schemas to new names, and every reference to them with them, across a whole document. |
|
SchemaValues
|
The values a schema lists and suggests - its enum, default, example and
const - written as the type the schema describes. |
|
UrlMappingPaths
|
Converts the pattern of a Grails URL mapping to the OpenAPI paths it serves. |
|
ValidationErrorsContent
|
The validation errors a request that cannot be bound is answered with, described once as a
schema of the document's own. |