Package com.atlassian.confluence.swagger.enricher

Class AbstractResponseDocsEnricher

java.lang.Object
com.atlassian.confluence.swagger.enricher.AbstractResponseDocsEnricher
All Implemented Interfaces:
BiConsumer<io.swagger.v3.oas.models.OpenAPI,Set<Class<?>>>
Direct Known Subclasses:
ConfluenceResponseDocEnricher
public abstract class AbstractResponseDocsEnricher extends Object implements BiConsumer<io.swagger.v3.oas.models.OpenAPI,Set<Class<?>>>
Cloned from com.atlassian.dc.swagger:processor 1.x.
Since:
10.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractResponseDocsEnricher()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    accept(io.swagger.v3.oas.models.OpenAPI openAPI, Set<Class<?>> classes)
     
    protected void
    addRestResponse(Class<?> resourceClass, com.atlassian.dc.swagger.annotations.ResponseDoc responseDoc, io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.Operation operation)
     
    protected abstract io.swagger.v3.oas.models.responses.ApiResponse
    createRestErrorResponse(Class<?> resourceClass, io.swagger.v3.oas.models.OpenAPI openAPI, String documentation)
     
    protected abstract void
    enrichPagedResponse(Class<?> resourceClass, com.atlassian.dc.swagger.annotations.ResponseDoc responseDoc, io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.Operation operation, io.swagger.v3.oas.models.media.MediaType returnType, Class<?> entity, Map<String,io.swagger.v3.oas.models.media.Schema> schemasByClassName)
     
    protected abstract String
    getRestPageModelName()
     
    protected abstract Map<String,io.swagger.v3.oas.models.media.Schema>
    getSchemas(ClassLoader classLoader, io.swagger.v3.oas.models.OpenAPI openAPI, String... classNames)
     
    static void
    stripExtraProperties(io.swagger.v3.oas.models.media.Schema<?> schema)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.util.function.BiConsumer

    andThen

  • Constructor Details

    • AbstractResponseDocsEnricher

      public AbstractResponseDocsEnricher()

  • Method Details

    • accept

      public void accept(io.swagger.v3.oas.models.OpenAPI openAPI, Set<Class<?>> classes)
      Specified by:
      accept in interface BiConsumer<io.swagger.v3.oas.models.OpenAPI,Set<Class<?>>>

    • createRestErrorResponse

      protected abstract io.swagger.v3.oas.models.responses.ApiResponse createRestErrorResponse(Class<?> resourceClass, io.swagger.v3.oas.models.OpenAPI openAPI, String documentation)

    • getRestPageModelName

      protected abstract String getRestPageModelName()

    • enrichPagedResponse

      protected abstract void enrichPagedResponse(Class<?> resourceClass, com.atlassian.dc.swagger.annotations.ResponseDoc responseDoc, io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.Operation operation, io.swagger.v3.oas.models.media.MediaType returnType, Class<?> entity, Map<String,io.swagger.v3.oas.models.media.Schema> schemasByClassName)

    • addRestResponse

      protected void addRestResponse(Class<?> resourceClass, com.atlassian.dc.swagger.annotations.ResponseDoc responseDoc, io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.Operation operation)
      Parameters:
      resourceClass - class with resource(s) in it. Must be provided to load response representations
      responseDoc - annotation for the operation to extract information from
      openAPI -
      operation -

    • getSchemas

      protected abstract Map<String,io.swagger.v3.oas.models.media.Schema> getSchemas(ClassLoader classLoader, io.swagger.v3.oas.models.OpenAPI openAPI, String... classNames)

    • stripExtraProperties

      public static void stripExtraProperties(io.swagger.v3.oas.models.media.Schema<?> schema)