Class OpenAPISpecContext


  • public class OpenAPISpecContext
    extends Object
    This class is used to store the operation context generated from the given openapi spec.
    • Method Detail

      • getRequestCookie

        public OpenAPIRequestCookie getRequestCookie()
        Retrieve the imported operation's request cookie for this spec's operation execution.
        Returns:
        the OpenAPIRequestCookie
      • getResponseCookie

        public OpenAPIResponseCookie getResponseCookie()
        Retrieves the imported operation's response cookie for this spec's operation execution.
        Returns:
        the OpenAPIResponseCookie
      • getSelectedRequestContentType

        public String getSelectedRequestContentType()
        Return the request content type for this operation's request. If this is null, the request body is not necessary.
        Returns:
        the request content type
      • getSelectedResponseContentType

        public String getSelectedResponseContentType()
        Returns the response content type for this operation's response. If this is null, the response body is not necessary
        Returns:
        the response content type
      • getSelectedRequestMedia

        public io.swagger.v3.oas.models.media.MediaType getSelectedRequestMedia()
        Returns the media type definition of the request. If this is null, then the request body is not necessary.
        Returns:
        the request MediaType
      • getSelectedResponseMedia

        public io.swagger.v3.oas.models.media.MediaType getSelectedResponseMedia()
        Returns the media type definition of the response. If this is null, then the request body is not necessary.
        Returns:
        the response MediaType
      • getBrowseFields

        public Map<OpenAPIParameterType,​List<BrowseField>> getBrowseFields()
        Retrieve all of the operation's ui fields for this spec's operation, this map is not mutable.
        Returns:
        Map of Parameter Type to Browse Fields
      • getBrowseFieldByType

        public List<BrowseField> getBrowseFieldByType​(OpenAPIParameterType parameterType)
        Retrieve specific ui fields by OpenAPIParameterType specific parameter types. this list is not mutable.
        Parameters:
        parameterType - the parameter type
        Returns:
        List of Browse Fields