Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
Requirement
Title | Service description coverage |
Identifier | SWIM-SERV-001 |
Requirement | A service description shall describe a single service. |
Rationale | The readability of any service description is improved by keeping it focussed on one service. |
Verification | Completeness: Not Applicable. Consistency: Not Applicable. Correctness: Verify that one and only one service is described. |
Examples/Notes | |
Level of Implementation | Mandatory |
Guidance
No guidance is provided for the general case.
Case of a composed service
Case where the described service is composed of other services, consists of underlying services, such as for an orchestration.
The objective of the service description is to describe the composed service as a single service, in order for the service consumer to make good use of that composed service.
Information on the underlying services may be added, but is not required by the specification.
It is good SOA practice that a service appears as a black-box to its consumers.
Guidance for JSON service description
Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
Guidance
At highest level, create an object with the single attribute informationService.
Example
{ "informationService": { ... } }
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.