Package io.muserver.openapi

Class PathItemObjectBuilder

  • public class PathItemObjectBuilder
extends java.lang.Object
    Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.

    • Constructor Detail

      • PathItemObjectBuilder

        public PathItemObjectBuilder()

    • Method Detail

      • withSummary

        public PathItemObjectBuilder withSummary​(java.lang.String summary)
        Parameters:
        summary - An optional, string summary, intended to apply to all operations in this path.
        Returns:
        The current builder

      • withDescription

        public PathItemObjectBuilder withDescription​(java.lang.String description)
        Parameters:
        description - An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.
        Returns:
        The current builder

      • withOperations

        public PathItemObjectBuilder withOperations​(java.util.Map<java.lang.String,​OperationObject> operations)
        Parameters:
        operations - The operations allowed on this path, where the keys to the map are GET, POST etc.
        Returns:
        The current builder

      • withServers

        public PathItemObjectBuilder withServers​(java.util.List<ServerObject> servers)
        Parameters:
        servers - An alternative server array to service all operations in this path.
        Returns:
        The current builder

      • withParameters

        public PathItemObjectBuilder withParameters​(java.util.List<ParameterObject> parameters)
        Parameters:
        parameters - A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.
        Returns:
        The current builder