io.inversion.action.openapi

Interface OpenAPIWriter<T extends OpenAPIWriter>

All Known Implementing Classes:

AclFilter, Action, AuthFilter, BatchAction, CsvAction, DbAction, DbDeleteAction, DbGetAction, FileAction, Filter, HALFilter, HATEOASFilter, LinksFilter, MockAction, OpenAPIAction, OpenAPISpecWriter, SdkFilter

public interface OpenAPIWriter<T extends OpenAPIWriter>

Method Summary

Modifier and Type	Method and Description
default OpenAPIWriter	addResponse(io.swagger.v3.oas.models.Operation operation, Op op, java.lang.String status)
default OpenAPIWriter	addResponse(io.swagger.v3.oas.models.Operation operation, Op op, java.lang.String status, java.lang.String description, java.lang.String schemaName)
default java.lang.String	beautifyTag(java.lang.String str)
default io.swagger.v3.oas.models.Operation	buildOperation(Op op, java.lang.String description, java.lang.String requestSchema, java.lang.String... statusAndSchema)
default io.swagger.v3.oas.models.Operation	documentOpDelete(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
default java.lang.String	documentOperationSchema(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, boolean request, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
default io.swagger.v3.oas.models.Operation	documentOpFind(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
default io.swagger.v3.oas.models.Operation	documentOpGet(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
default io.swagger.v3.oas.models.Operation	documentOpPatch(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
default io.swagger.v3.oas.models.Operation	documentOpPost(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
default io.swagger.v3.oas.models.Operation	documentOpPut(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
default io.swagger.v3.oas.models.Operation	documentOpRelated(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
default void	documentParam(io.inversion.utils.Task docTask, io.swagger.v3.oas.models.OpenAPI openApi, io.swagger.v3.oas.models.Operation operation, Op op, Param param)
default void	documentQueryParams(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, io.swagger.v3.oas.models.Operation operation, Op op)
default java.lang.String	documentRequestSchema(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
default java.lang.String	documentResourceSchema(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
default java.lang.String	documentResponseSchema(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
default Op	findOp(java.util.List<Op> ops, Op.OpFunction fun, Collection collection)
default java.lang.String	getDescription(Op op)
default java.lang.String	getSchemaRef(java.lang.String nameOrRef)
default boolean	hasParam(io.swagger.v3.oas.models.Operation operation, io.swagger.v3.oas.models.parameters.Parameter param)
default io.swagger.v3.oas.models.Operation	hook_documentOp(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
default io.swagger.v3.oas.models.media.Schema	newComponentRefSchema(java.lang.String nameOrRef)
default io.swagger.v3.oas.models.media.Schema	newHrefSchema()
default io.swagger.v3.oas.models.media.Schema	newTypeSchema(java.lang.String type, java.lang.String description)
default void	removeReadOnlyProperties(io.swagger.v3.oas.models.OpenAPI openApi, Collection coll, java.lang.String schemaName)

Method Detail

hook_documentOp

default io.swagger.v3.oas.models.Operation hook_documentOp(io.inversion.utils.Task docChain,
                                                           io.swagger.v3.oas.models.OpenAPI openApi,
                                                           java.util.List<Op> ops,
                                                           Op op,
                                                           java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

documentOpGet

default io.swagger.v3.oas.models.Operation documentOpGet(io.inversion.utils.Task docChain,
                                                         io.swagger.v3.oas.models.OpenAPI openApi,
                                                         java.util.List<Op> ops,
                                                         Op op,
                                                         java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

documentOpFind

default io.swagger.v3.oas.models.Operation documentOpFind(io.inversion.utils.Task docChain,
                                                          io.swagger.v3.oas.models.OpenAPI openApi,
                                                          java.util.List<Op> ops,
                                                          Op op,
                                                          java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

documentOpRelated

default io.swagger.v3.oas.models.Operation documentOpRelated(io.inversion.utils.Task docChain,
                                                             io.swagger.v3.oas.models.OpenAPI openApi,
                                                             java.util.List<Op> ops,
                                                             Op op,
                                                             java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

removeReadOnlyProperties

default void removeReadOnlyProperties(io.swagger.v3.oas.models.OpenAPI openApi,
                                      Collection coll,
                                      java.lang.String schemaName)

documentOpPost

default io.swagger.v3.oas.models.Operation documentOpPost(io.inversion.utils.Task docChain,
                                                          io.swagger.v3.oas.models.OpenAPI openApi,
                                                          java.util.List<Op> ops,
                                                          Op op,
                                                          java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

documentOpPut

default io.swagger.v3.oas.models.Operation documentOpPut(io.inversion.utils.Task docChain,
                                                         io.swagger.v3.oas.models.OpenAPI openApi,
                                                         java.util.List<Op> ops,
                                                         Op op,
                                                         java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

documentOpPatch

default io.swagger.v3.oas.models.Operation documentOpPatch(io.inversion.utils.Task docChain,
                                                           io.swagger.v3.oas.models.OpenAPI openApi,
                                                           java.util.List<Op> ops,
                                                           Op op,
                                                           java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

documentOpDelete

default io.swagger.v3.oas.models.Operation documentOpDelete(io.inversion.utils.Task docChain,
                                                            io.swagger.v3.oas.models.OpenAPI openApi,
                                                            java.util.List<Op> ops,
                                                            Op op,
                                                            java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

documentRequestSchema

default java.lang.String documentRequestSchema(io.inversion.utils.Task docChain,
                                               io.swagger.v3.oas.models.OpenAPI openApi,
                                               java.util.List<Op> ops,
                                               Op op,
                                               java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

documentResponseSchema

default java.lang.String documentResponseSchema(io.inversion.utils.Task docChain,
                                                io.swagger.v3.oas.models.OpenAPI openApi,
                                                java.util.List<Op> ops,
                                                Op op,
                                                java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

documentOperationSchema

default java.lang.String documentOperationSchema(io.inversion.utils.Task docChain,
                                                 io.swagger.v3.oas.models.OpenAPI openApi,
                                                 java.util.List<Op> ops,
                                                 Op op,
                                                 boolean request,
                                                 java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

documentResourceSchema

default java.lang.String documentResourceSchema(io.inversion.utils.Task docChain,
                                                io.swagger.v3.oas.models.OpenAPI openApi,
                                                java.util.List<Op> ops,
                                                Op op,
                                                java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

buildOperation

default io.swagger.v3.oas.models.Operation buildOperation(Op op,
                                                          java.lang.String description,
                                                          java.lang.String requestSchema,
                                                          java.lang.String... statusAndSchema)

getDescription

default java.lang.String getDescription(Op op)

addResponse

default OpenAPIWriter addResponse(io.swagger.v3.oas.models.Operation operation,
                                  Op op,
                                  java.lang.String status)

addResponse

default OpenAPIWriter addResponse(io.swagger.v3.oas.models.Operation operation,
                                  Op op,
                                  java.lang.String status,
                                  java.lang.String description,
                                  java.lang.String schemaName)

documentQueryParams

default void documentQueryParams(io.inversion.utils.Task docChain,
                                 io.swagger.v3.oas.models.OpenAPI openApi,
                                 io.swagger.v3.oas.models.Operation operation,
                                 Op op)

documentParam

default void documentParam(io.inversion.utils.Task docTask,
                           io.swagger.v3.oas.models.OpenAPI openApi,
                           io.swagger.v3.oas.models.Operation operation,
                           Op op,
                           Param param)

hasParam

default boolean hasParam(io.swagger.v3.oas.models.Operation operation,
                         io.swagger.v3.oas.models.parameters.Parameter param)

newTypeSchema

default io.swagger.v3.oas.models.media.Schema newTypeSchema(java.lang.String type,
                                                            java.lang.String description)

newHrefSchema

default io.swagger.v3.oas.models.media.Schema newHrefSchema()

newComponentRefSchema

default io.swagger.v3.oas.models.media.Schema newComponentRefSchema(java.lang.String nameOrRef)

getSchemaRef

default java.lang.String getSchemaRef(java.lang.String nameOrRef)

beautifyTag

default java.lang.String beautifyTag(java.lang.String str)

findOp

default Op findOp(java.util.List<Op> ops,
                  Op.OpFunction fun,
                  Collection collection)