Module org.eclipse.microprofile.openapi
Package org.eclipse.microprofile.openapi.models.responses

Interface APIResponse

    • Method Detail

      • getDescription

        String getDescription()
        Returns a short description of this instance of ApiResponse.
        Returns:
        a short description of the response

      • setDescription

        void setDescription​(String description)
        Sets the description of this instance of ApiResponse.
        Parameters:
        description - a short description of the response

      • description

        default APIResponse description​(String description)
        Sets the description of this instance of ApiResponse and returns this ApiResponse instance.
        Parameters:
        description - a short description of the response
        Returns:
        this ApiResponse instance

      • getHeaders

        Map<String,​Header> getHeaders()
        Returns the map of Headers in this instance of ApiResponse.
        Returns:
        a copy Map (potentially immutable) of the headers of this response

      • setHeaders

        void setHeaders​(Map<String,​Header> headers)
        Sets the Headers for this instance of ApiResponse with the given map of Headers. The Header names are case insensitive and if a Header is defined with the name 'Content-Type', then it will be ignored.
        Parameters:
        headers - the headers of the response

      • headers

        default APIResponse headers​(Map<String,​Header> headers)
        Sets the Headers for this instance of ApiResponse with the given map of Headers and returns this instance of ApiResponse. The Header names are case insensitive and if a Header is defined with the name 'Content-Type', then it will be ignored.
        Parameters:
        headers - the headers of the response
        Returns:
        this ApiResponse instance

      • addHeader

        APIResponse addHeader​(String name,
                      Header header)
        Adds the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse. If this ApiResponse instance does not have any headers, a new map is created and the given header is added.
        Parameters:
        name - the unique name of the header
        header - a header for the response. null values will be rejected (implementation will throw an exception) or ignored.
        Returns:
        this ApiResponse instance

      • removeHeader

        void removeHeader​(String name)
        Removes the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse. If this ApiResponse instance does not have any headers, a new map is created and the given header is added.
        Parameters:
        name - the unique name of the header

      • getContent

        Content getContent()
        Returns the map containing descriptions of potential response payload for this instance of ApiResponse.
        Returns:
        the potential content of the response

      • setContent

        void setContent​(Content content)
        Sets the map containing descriptions of potential response payload for this instance of ApiResponse.
        Parameters:
        content - the potential content of the response

      • content

        default APIResponse content​(Content content)
        Sets the map containing descriptions of potential response payload for this instance of ApiResponse and returns this ApiResponse instance.
        Parameters:
        content - the potential content of the response
        Returns:
        this ApiResponse instance

      • getLinks

        Map<String,​Link> getLinks()
        Returns the operations links that can be followed from this instance of ApiResponse.
        Returns:
        a copy Map (potentially immutable) of links that can be followed from the response

      • setLinks

        void setLinks​(Map<String,​Link> links)
        Sets the operations links that can be followed from this instance of ApiResponse.
        Parameters:
        links - the operation links followed from the response

      • links

        default APIResponse links​(Map<String,​Link> links)
        Sets the operations links that can be followed from this instance of ApiResponse.
        Parameters:
        links - the operation links followed from the response
        Returns:
        current APIResponse instance

      • addLink

        APIResponse addLink​(String name,
                    Link link)
        Adds a link to this instance of ApiResponse using the given name and Link, and returns this ApiResponse instance.
        Parameters:
        name - the short name of the link
        link - the operation link that can be followed from the response. null values will be rejected (implementation will throw an exception) or ignored.
        Returns:
        this ApiResponse instance

      • removeLink

        void removeLink​(String name)
        Removes a link to this instance of ApiResponse using the given name and Link.
        Parameters:
        name - the short name of the link