Package io.inversion.action.openapi

Class OpenAPISpecWriter

java.lang.Object

io.inversion.action.openapi.OpenAPISpecWriter

All Implemented Interfaces:

OpenAPIWriter<OpenAPISpecWriter>

public class OpenAPISpecWriter
extends java.lang.Object
implements OpenAPIWriter<OpenAPISpecWriter>

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<java.lang.String>	ignoredSuffixes

Constructor Summary

Constructors

Constructor	Description
OpenAPISpecWriter()

Method Summary

Modifier and Type	Method	Description
protected void	documentErrorSchema(io.swagger.v3.oas.models.OpenAPI openApi)
protected void	documentInfo(io.swagger.v3.oas.models.OpenAPI openApi, io.inversion.Request req)
protected void	documentOperations(io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<io.inversion.Op> ops, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
protected void	documentPathItem(io.swagger.v3.oas.models.OpenAPI openApi, io.inversion.Op op)
protected void	documentPathItems(io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<io.inversion.Op> opsToDoc)
protected void	documentSchemas(io.swagger.v3.oas.models.OpenAPI openApi, io.inversion.Request req)
protected void	documentServers(io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<io.inversion.Op> ops, io.inversion.Request req)
protected java.lang.String	getDescription()
protected java.lang.String	getDescription(io.inversion.action.security.AuthScheme scheme, io.inversion.Param param)
io.swagger.v3.oas.models.Operation	hook_documentOp(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<io.inversion.Op> ops, io.inversion.Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
protected void	removeInternalOps(io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<io.inversion.Op> ops)
io.swagger.v3.oas.models.OpenAPI	writeOpenAPI(io.inversion.Request req, io.swagger.v3.oas.models.OpenAPI openApi)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.inversion.action.openapi.OpenAPIWriter

addResponse, addResponse, beautifyTag, buildOperation, documentOpDelete, documentOperationSchema, documentOpFind, documentOpGet, documentOpPatch, documentOpPost, documentOpPut, documentOpRelated, documentParam, documentQueryParams, documentRequestSchema, documentResourceSchema, documentResponseSchema, findOp, getDescription, getSchemaRef, hasParam, newComponentRefSchema, newHrefSchema, newTypeSchema, removeReadOnlyProperties

Field Detail

ignoredSuffixes

protected java.util.List<java.lang.String> ignoredSuffixes

Constructor Detail

OpenAPISpecWriter

public OpenAPISpecWriter()

Method Detail

getDescription

protected java.lang.String getDescription()

writeOpenAPI

public io.swagger.v3.oas.models.OpenAPI writeOpenAPI(io.inversion.Request req,
                                                     io.swagger.v3.oas.models.OpenAPI openApi)
                                              throws io.inversion.ApiException

Throws:

io.inversion.ApiException

removeInternalOps

protected void removeInternalOps(io.swagger.v3.oas.models.OpenAPI openApi,
                                 java.util.List<io.inversion.Op> ops)

documentInfo

protected void documentInfo(io.swagger.v3.oas.models.OpenAPI openApi,
                            io.inversion.Request req)

documentServers

protected void documentServers(io.swagger.v3.oas.models.OpenAPI openApi,
                               java.util.List<io.inversion.Op> ops,
                               io.inversion.Request req)

documentSchemas

protected void documentSchemas(io.swagger.v3.oas.models.OpenAPI openApi,
                               io.inversion.Request req)

getDescription

protected java.lang.String getDescription(io.inversion.action.security.AuthScheme scheme,
                                          io.inversion.Param param)

documentErrorSchema

protected void documentErrorSchema(io.swagger.v3.oas.models.OpenAPI openApi)

documentPathItems

protected void documentPathItems(io.swagger.v3.oas.models.OpenAPI openApi,
                                 java.util.List<io.inversion.Op> opsToDoc)

documentPathItem

protected void documentPathItem(io.swagger.v3.oas.models.OpenAPI openApi,
                                io.inversion.Op op)

documentOperations

protected void documentOperations(io.swagger.v3.oas.models.OpenAPI openApi,
                                  java.util.List<io.inversion.Op> ops,
                                  java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

hook_documentOp

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

Specified by:

hook_documentOp in interface OpenAPIWriter<OpenAPISpecWriter>