Naming CORSSMINER REST Services

When to use this guideline ?

This guideline present how to define the route ( a new REST service provided by the CORSSMINER platform.

Context

The REST services are the main integration points between platform components or between the platform and external clients. In order to provide an unified view of platform services , we need to used a common naming schema for all REST services provided by the platform.

Who to name a REST service ?

/{componentid}/{categoryname}/{servicename}

• /componentid/: Name of the Architectural component which provide the service
• /categoryname/ (Optional) : optional category of the service
• /servicename/ : Name of the rest service

Component

Component	ComponentId
DevOps Dashboard	dashboard
Workflow Execution Engine	workflow
Knowledge Base	knowledgebase
Metric Provider	metricprovider
Administration	administration

Comment