com.networknt.oas.model.Path Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-parser Show documentation
Show all versions of openapi-parser Show documentation
A light-weight, fast OpenAPI 3.0 parser and validator
package com.networknt.oas.model;
import com.networknt.oas.jsonoverlay.Reference;
import java.util.Collection;
import java.util.Map;
public interface Path extends OpenApiObject {
// Summary
String getSummary();
String getSummary(boolean elaborate);
void setSummary(String summary);
// Description
String getDescription();
String getDescription(boolean elaborate);
void setDescription(String description);
// Operation
Map getOperations();
Map getOperations(boolean elaborate);
boolean hasOperation(String name);
Operation getOperation(String name);
void setOperations(Map operations);
void setOperation(String name, Operation operation);
void removeOperation(String name);
// Get
Operation getGet();
Operation getGet(boolean elaborate);
void setGet(Operation get);
// Put
Operation getPut();
Operation getPut(boolean elaborate);
void setPut(Operation put);
// Post
Operation getPost();
Operation getPost(boolean elaborate);
void setPost(Operation post);
// Delete
Operation getDelete();
Operation getDelete(boolean elaborate);
void setDelete(Operation delete);
// Options
Operation getOptions();
Operation getOptions(boolean elaborate);
void setOptions(Operation options);
// Head
Operation getHead();
Operation getHead(boolean elaborate);
void setHead(Operation head);
// Patch
Operation getPatch();
Operation getPatch(boolean elaborate);
void setPatch(Operation patch);
// Trace
Operation getTrace();
Operation getTrace(boolean elaborate);
void setTrace(Operation trace);
// Server
Collection getServers();
Collection getServers(boolean elaborate);
boolean hasServers();
Server getServer(int index);
void setServers(Collection servers);
void setServer(int index, Server server);
void addServer(Server server);
void insertServer(int index, Server server);
void removeServer(int index);
// Parameter
Collection getParameters();
Collection getParameters(boolean elaborate);
boolean hasParameters();
Parameter getParameter(int index);
void setParameters(Collection parameters);
void setParameter(int index, Parameter parameter);
void addParameter(Parameter parameter);
void insertParameter(int index, Parameter parameter);
void removeParameter(int index);
boolean isParameterReference(int index);
Reference getParameterReference(int index);
// Extension
Map getExtensions();
Map getExtensions(boolean elaborate);
boolean hasExtension(String name);
Object getExtension(String name);
void setExtensions(Map extensions);
void setExtension(String name, Object extension);
void removeExtension(String name);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy