@CompileStatic class OpenApiSelection extends java.lang.Object
Which operations a document describes: the default document, or one named group.
The criteria are the ones springdoc applies to a group: they are read from
grails.openapi for the default document and from grails.openapi.groups.<name> for
a group, and from a springdoc GroupedOpenApi where the application declares one, so a
document generated at build time and one springdoc serves select the same operations.
A path criterion is an Ant pattern matched against the described path, such as
/api/v1/**. A package criterion names the package of the controller that serves the
operation, and matches its sub-packages too. A media type or header criterion is matched the way
springdoc matches a handler method: an operation matches only where it produces, consumes, or
declares exactly what the criterion lists. A criterion left empty selects everything.
| Type | Name and description |
|---|---|
java.util.List<java.lang.String> |
consumesToMatchThe media types an operation must consume: those it produces, where it binds a body. |
java.lang.String |
displayNameThe title of the document, and the name a viewer shows for the group. |
java.lang.String |
groupThe group name, or null for the default document. |
java.util.List<java.lang.String> |
headersToMatchThe header conditions an operation must declare, such as Accept-Version=1.0. |
java.util.List<java.lang.String> |
packagesToExcludeThe packages, with their sub-packages, of the controllers whose operations are left out. |
java.util.List<java.lang.String> |
packagesToScanThe packages, with their sub-packages, of the controllers whose operations are described; empty for every package. |
java.util.List<java.lang.String> |
pathsToExcludeAnt patterns of the paths left out. |
java.util.List<java.lang.String> |
pathsToMatchAnt patterns of the paths described, such as /api/v1/**; empty for every path. |
java.util.List<java.lang.String> |
producesToMatchThe media types an operation must produce: those of the formats its controller declares in responseFormats, or application/json where it declares none. |
| Constructor and description |
|---|
OpenApiSelection() |
OpenApiSelection(OpenApiSelection criteria)A selection with the same criteria as another. |
| 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) |
The media types an operation must consume: those it produces, where it binds a body.
The title of the document, and the name a viewer shows for the group.
The group name, or null for the default document.
The header conditions an operation must declare, such as Accept-Version=1.0.
The packages, with their sub-packages, of the controllers whose operations are left out.
The packages, with their sub-packages, of the controllers whose operations are described; empty for every package.
Ant patterns of the paths left out.
Ant patterns of the paths described, such as /api/v1/**; empty for every path.
The media types an operation must produce: those of the formats its controller declares in
responseFormats, or application/json where it declares none.
A selection with the same criteria as another.