Package io.muserver.openapi

Class LinkObjectBuilder

  • public class LinkObjectBuilder
extends java.lang.Object

    The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.

    Unlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.

    For computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.

    • Constructor Detail

      • LinkObjectBuilder

        public LinkObjectBuilder()

    • Method Detail

      • withOperationId

        public LinkObjectBuilder withOperationId​(java.lang.String operationId)
        Parameters:
        operationId - The name of an existing, resolvable OAS operation, as defined with a unique operationId.
        Returns:
        The current builder

      • withParameters

        public LinkObjectBuilder withParameters​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
        Parameters:
        parameters - A map representing parameters to pass to an operation as specified with operationId. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use the same parameter name in different locations (e.g. path.id).
        Returns:
        The current builder

      • withRequestBody

        public LinkObjectBuilder withRequestBody​(java.lang.Object requestBody)
        Parameters:
        requestBody - A literal value or {expression} to use as a request body when calling the target operation.
        Returns:
        The current builder

      • withDescription

        public LinkObjectBuilder withDescription​(java.lang.String description)
        Parameters:
        description - A description of the link. CommonMark syntax MAY be used for rich text representation.
        Returns:
        The current builder

      • withServer

        public LinkObjectBuilder withServer​(ServerObject server)
        Parameters:
        server - A server object to be used by the target operation.
        Returns:
        The current builder

      • build

        public LinkObject build()
        Returns:
        A new object