Package io.inversion.action.openapi

Interface OpenAPIWriter<T extends OpenAPIWriter>

All Known Implementing Classes:
OpenAPISpecWriter
public interface OpenAPIWriter<T extends OpenAPIWriter>

  • Method Summary

    Modifier and Type
    Method
    Description
    default OpenAPIWriter
    addResponse(io.swagger.v3.oas.models.Operation operation, io.inversion.Op op, String status)
     
    default OpenAPIWriter
    addResponse(io.swagger.v3.oas.models.Operation operation, io.inversion.Op op, String status, String description, String schemaName)
     
    default String
    beautifyTag(String str)
     
    default io.swagger.v3.oas.models.Operation
    buildOperation(io.inversion.Op op, String description, String requestSchema, String... statusAndSchema)
     
    default io.swagger.v3.oas.models.Operation
    documentOpDelete(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, List<io.inversion.Op> ops, io.inversion.Op op, Map<Object,io.swagger.v3.oas.models.media.Schema> schemas)
     
    default String
    documentOperationSchema(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, List<io.inversion.Op> ops, io.inversion.Op op, boolean request, Map<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, List<io.inversion.Op> ops, io.inversion.Op op, Map<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, List<io.inversion.Op> ops, io.inversion.Op op, Map<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, List<io.inversion.Op> ops, io.inversion.Op op, Map<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, List<io.inversion.Op> ops, io.inversion.Op op, Map<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, List<io.inversion.Op> ops, io.inversion.Op op, Map<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, List<io.inversion.Op> ops, io.inversion.Op op, Map<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, io.inversion.Op op, io.inversion.Param param)
     
    default void
    documentQueryParams(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, io.swagger.v3.oas.models.Operation operation, io.inversion.Op op)
     
    default String
    documentRequestSchema(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, List<io.inversion.Op> ops, io.inversion.Op op, Map<Object,io.swagger.v3.oas.models.media.Schema> schemas)
     
    default String
    documentResourceSchema(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, List<io.inversion.Op> ops, io.inversion.Op op, Map<Object,io.swagger.v3.oas.models.media.Schema> schemas)
     
    default String
    documentResponseSchema(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, List<io.inversion.Op> ops, io.inversion.Op op, Map<Object,io.swagger.v3.oas.models.media.Schema> schemas)
     
    default io.inversion.Op
    findOp(List<io.inversion.Op> ops, io.inversion.Op.OpFunction fun, io.inversion.Collection collection)
     
    default String
    getDescription(io.inversion.Op op)
     
    default String
    getSchemaRef(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, List<io.inversion.Op> ops, io.inversion.Op op, Map<Object,io.swagger.v3.oas.models.media.Schema> schemas)
     
    default io.swagger.v3.oas.models.media.Schema
    newComponentRefSchema(String nameOrRef)
     
    default io.swagger.v3.oas.models.media.Schema
    newHrefSchema()
     
    default io.swagger.v3.oas.models.media.Schema
    newTypeSchema(String type, String description)
     
    default void
    removeReadOnlyProperties(io.swagger.v3.oas.models.OpenAPI openApi, io.inversion.Collection coll, String schemaName)
     

  • Method Details

    • hook_documentOp

      default io.swagger.v3.oas.models.Operation hook_documentOp(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, List<io.inversion.Op> ops, io.inversion.Op op, Map<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, List<io.inversion.Op> ops, io.inversion.Op op, Map<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, List<io.inversion.Op> ops, io.inversion.Op op, Map<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, List<io.inversion.Op> ops, io.inversion.Op op, Map<Object,io.swagger.v3.oas.models.media.Schema> schemas)

    • removeReadOnlyProperties

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

    • documentOpPost

      default io.swagger.v3.oas.models.Operation documentOpPost(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, List<io.inversion.Op> ops, io.inversion.Op op, Map<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, List<io.inversion.Op> ops, io.inversion.Op op, Map<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, List<io.inversion.Op> ops, io.inversion.Op op, Map<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, List<io.inversion.Op> ops, io.inversion.Op op, Map<Object,io.swagger.v3.oas.models.media.Schema> schemas)

    • documentRequestSchema

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

    • documentResponseSchema

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

    • documentOperationSchema

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

    • documentResourceSchema

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

    • buildOperation

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

    • getDescription

      default String getDescription(io.inversion.Op op)

    • addResponse

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

    • addResponse

      default OpenAPIWriter addResponse(io.swagger.v3.oas.models.Operation operation, io.inversion.Op op, String status, String description, 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, io.inversion.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, io.inversion.Op op, io.inversion.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(String type, String description)

    • newHrefSchema

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

    • newComponentRefSchema

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

    • getSchemaRef

      default String getSchemaRef(String nameOrRef)

    • beautifyTag

      default String beautifyTag(String str)

    • findOp

      default io.inversion.Op findOp(List<io.inversion.Op> ops, io.inversion.Op.OpFunction fun, io.inversion.Collection collection)