@CompileStatic class DocumentCompletion extends java.lang.Object
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.
| Constructor and description |
|---|
DocumentCompletion() |
| Type Params | Return Type | Name and description |
|---|---|---|
|
static void |
disambiguateOperationIds(io.swagger.v3.oas.models.Paths paths)An identifier must be unique across the document. |
|
static void |
dropUnresolvedReferences(io.swagger.v3.oas.models.Paths paths, io.swagger.v3.oas.models.Components components)Removes a reference to a schema that is not in the document. |
|
static void |
registerTags(io.swagger.v3.oas.models.OpenAPI openApi, io.swagger.v3.oas.models.Paths paths, java.util.Collection<GrailsControllerClass> controllers)Describes the tags the documented controllers declare, so a grouping carries its description rather than only its name. |
| Methods inherited from class | Name |
|---|---|
class java.lang.Object |
java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int) |
An identifier must be unique across the document. The same action reached through more than one mapping derives the same identifier, so the later one is qualified by the path it is reached at, which depends on the path rather than on the order the mappings were read.
Removes a reference to a schema that is not in the document. A class that could not be described leaves the operations that referred to it pointing at nothing, and a reference that does not resolve is worse for a code generator than an operation described without a shape.
Describes the tags the documented controllers declare, so a grouping carries its description rather than only its name.