Package org.praxisplatform.uischema.controller.docs

Class DomainCatalogController.EndpointSummary

java.lang.Object

org.praxisplatform.uischema.controller.docs.DomainCatalogController.EndpointSummary

Enclosing class:

DomainCatalogController

public static class DomainCatalogController.EndpointSummary
extends Object

Constructor Summary

Constructors

Constructor	Description
EndpointSummary(String path, String method, List<String> tags, String summary, String description, String operationId, DomainCatalogController.SchemaRef requestSchema, DomainCatalogController.SchemaRef responseSchema, List<DomainCatalogController.ParameterSummary> parameters, Map<String,Map<String,Object>> operationExamples, DomainCatalogController.SchemaLinks schemaLinks)

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getMethod()
Map<String,Map<String,Object>>	getOperationExamples()
String	getOperationId()
List<DomainCatalogController.ParameterSummary>	getParameters()
String	getPath()
DomainCatalogController.SchemaRef	getRequestSchema()
DomainCatalogController.SchemaRef	getResponseSchema()
DomainCatalogController.SchemaLinks	getSchemaLinks()
String	getSummary()
List<String>	getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EndpointSummary

public EndpointSummary(String path,
 String method,
 List<String> tags,
 String summary,
 String description,
 String operationId,
 DomainCatalogController.SchemaRef requestSchema,
 DomainCatalogController.SchemaRef responseSchema,
 List<DomainCatalogController.ParameterSummary> parameters,
 Map<String,Map<String,Object>> operationExamples,
 DomainCatalogController.SchemaLinks schemaLinks)

Method Details

getPath

public String getPath()

getMethod

public String getMethod()

getTags

public List<String> getTags()

getSummary

public String getSummary()

getDescription

public String getDescription()

getOperationId

public String getOperationId()

getRequestSchema

public DomainCatalogController.SchemaRef getRequestSchema()

getResponseSchema

public DomainCatalogController.SchemaRef getResponseSchema()

getParameters

public List<DomainCatalogController.ParameterSummary> getParameters()

getOperationExamples

public Map<String,Map<String,Object>> getOperationExamples()

getSchemaLinks

public DomainCatalogController.SchemaLinks getSchemaLinks()