io.muserver.openapi.PathItemObjectBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mu-server Show documentation
A simple but powerful web server framework
There is a newer version: 2.0.3
package io.muserver.openapi;

import java.util.List;
import java.util.Map;

/**
 * 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.
 */
public class PathItemObjectBuilder {
    private String summary;
    private String description;
    private Map operations;
    private List servers;
    private List parameters;

    /**
     * @param summary An optional, string summary, intended to apply to all operations in this path.
     * @return The current builder
     */
    public PathItemObjectBuilder withSummary(String summary) {
        this.summary = summary;
        return this;
    }

    /**
     * @param description An optional, string description, intended to apply to all operations in this path.
     *                    CommonMark syntax MAY be used for rich text representation.
     * @return The current builder
     */
    public PathItemObjectBuilder withDescription(String description) {
        this.description = description;
        return this;
    }

    /**
     * @param operations The operations allowed on this path, where the keys to the map are GET, POST etc.
     * @return The current builder
     */
    public PathItemObjectBuilder withOperations(Map operations) {
        this.operations = operations;
        return this;
    }

    /**
     * @param servers An alternative server array to service all operations in this path.
     * @return The current builder
     */
    public PathItemObjectBuilder withServers(List servers) {
        this.servers = servers;
        return this;
    }

    /**
     * @param 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.
     * @return The current builder
     */
    public PathItemObjectBuilder withParameters(List parameters) {
        this.parameters = parameters;
        return this;
    }

    public PathItemObject build() {
        return new PathItemObject(summary, description, operations, servers, parameters);
    }

    /**
     * Creates a builder for a {@link PathItemObject}
     *
     * @return A new builder
     */
    public static PathItemObjectBuilder pathItemObject() {
        return new PathItemObjectBuilder();
    }
}