Package com.ibm.wsspi.openapi
Interface OASProviderResult
-
public interface OASProviderResult
This interface wraps OpenAPI model asOpenAPI
, OpenAPI Specification document and theOASProviderConfig
representing this result.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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 bothgetOpenAPI
andgetDocument
methods return documents,getOpenAPI
takes precedence.- Returns:
OpenAPI
model representing the document. Must returnnull
ifgetDocument
is supposed to provide the OpenAPI spec document.
-
getDocument
java.lang.String getDocument()
This method can be used to provide OpenAPI Specification document. If bothgetOpenAPI
andgetDocument
methods return documents,getOpenAPI
takes precedence.- Returns:
- Document in the form of JSON or YAML.
-
getOASProviderConfig
OASProviderConfig getOASProviderConfig()
- Returns:
OASProviderConfig
representing the result.
-
-