Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
Requirement
Title | Service identification |
Identifier | SWIM-SERV-006 |
Requirement | A service description shall include:
|
Rationale | This requirement makes clear what the subject of the service description is. It supports the identification and citation of the service being described. |
Verification | Completeness: Verify that the 2 elements are included Consistency: Not Applicable. Correctness: Not Applicable. |
Examples/Notes | Example service identifications:
Note: To improve readability across service descriptions, it is best practice to apply following conventions for a service name:
|
Level of Implementation | Mandatory |
Guidance
Examples
See the Service Identification section within the Donlon TOBT Setting Service Description.
Guidance for JSON service description
Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
Guidance
Within field informationService, fill in the following attributes
attribute | type | description | guidance | rule |
---|---|---|---|---|
name | string | A piece of identifying information that gives stakeholders a way to reference or identify a service. | Provide the name of the service. Include the service name only: avoid suffixing with " service". | Mandatory |
version | string | The version of the information service. | Provide the version of the service. The version is always provided regardless of whether or not there are multiple versions of a service. Each version of a service shall have its own completed description. Rationale: enables consumers to distinguish between releases of the service. | Mandatory |
Example
"informationService": { ... "name": "TargetOffBlockTimeSetting", "version": "1.0.0", ... }
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.