com.ibm.wsspi.openapi

Interface OASProviderResult



  • public interface OASProviderResult
    This interface wraps OpenAPI model as OpenAPI, OpenAPI Specification document and the OASProviderConfig representing this result.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getDocument()
      This method can be used to provide OpenAPI Specification document.
      OASProviderConfig getOASProviderConfig() 
      io.swagger.oas.models.OpenAPI getOpenAPI()
      This method can be used to provide OpenAPI Specification document.
    • Method Detail

      • getOpenAPI

        io.swagger.oas.models.OpenAPI getOpenAPI()
        This method can be used to provide OpenAPI Specification document. If both getOpenAPI and getDocument methods return documents, getOpenAPI takes precedence.
        Returns:
        OpenAPI model representing the document. Must return null if getDocument is supposed to provide the OpenAPI spec document.
      • getDocument

        java.lang.String getDocument()
        This method can be used to provide OpenAPI Specification document. If both getOpenAPI and getDocument methods return documents, getOpenAPI takes precedence.
        Returns:
        Document in the form of JSON or YAML.