Task Status
This page is part of the ongoing SWIM communities of interest discussions. The content is working material. It should not be treated as final as it is still subject to review, comment and change.
Introduction
Service design...
Naming conventions
SWIM-SERV-140 Service functions
The functionality name could be somehow harmonised for AMQP services.
"generalDescription": {
"functionality": [{
"name": "...",
"description": "...",
"realWorldEffect": "..."
}, {
"name": "..",
"description": "...",
"realWorldEffect": "..."
}]
}
SWIM-SERV-240 Service interfaces
Name and description could be harmonised e.g. AMQP Notification, AMQP Subscription.
SWIM-SERV-240 already contains a <noun><role> pattern. e.g
- TurbulenceForecastPublisher for https://eur-registry.swim.aero/services/dwd-turbulence-amqp-10
- ArrivalSequenceInformationPublisher for https://eur-registry.swim.aero/services/dsna-arrivalsequencedistribution-service-v11 (not AMQP but shows the same pattern for names).
As far as AMQP is converned, what are the roles?
- Publisher, Queue, Message...
Name and description could be harmonised e.g. WFS Request.
SWIM-SERV-240 already contains a <noun><role> pattern. e.g
- NowCastSatRequest for https://eur-registry.swim.aero/services/dwd-nowcastsat-wfs-10
As far as WFS is concerned, what are the roles?
- Request...
SWIM-SERV-270 Service operations
A harmonised entry for AMQP delivery. Consider a controlled vocabulary of verbs for names.
SWIM-SERV-270 proposes <verb><noun> e.g. getAlerts; requestTrajectoryAnalysis; publishAirportMETInducedCapacity; setCoordinationAndTransferData; proposeARESDeActivation.
Which verbs are best in the context of AMQP?
Categorisation
SWIM-SERV-100 Service categories
The following example shows how to add a service categorisation for a Web Feature Service.
"serviceCategorisation": {
"other": [{
"name": "SERVICE_TYPE",
"value": "FEATURE_ACCESS_SERVICE",
"categorisationScheme": {
"url": "http://reference.swim.aero/information-services/service-categories/CodeServiceType"
}
}]
}