Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
Requirement
Title | Service description identification |
Identifier | SWIM-SERV-005 |
Requirement | A service description shall include:
|
Rationale | This requirement supports the identification and citation of a service description. |
Verification | Completeness: Verify that the 3 elements are included. Consistency: Not Applicable. Correctness: Not Applicable. |
Examples/Notes | Example service description identification:
Note: The edition of the service description is not to be confused with the version of the service. A service description can evolve to a new edition while still describing the same service version. |
Level of Implementation | Mandatory |
Guidance
Examples
See the Description 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 serviceDescriptionIdentification, itself witinh field descriptionInformation, fill the ServiceDescription attributes.
ServiceDescription - Mandatory
Information that supports the identification and citation of a service description
attribute | type | description | guidance | rule |
---|---|---|---|---|
serviceDescriptionTitle | string | The title by which the service description is known | Provide the title of the document | Mandatory |
serviceDescriptionEdition | string | The edition of the document | Provide the edition of the document edition vs version The edition of the service description is not to be confused with the version of the service. A service description can evolve to a new edition while still describing the same service version. | Mandatory |
serviceDescription ReferenceDate | string | A reference date for use in citing the service description | Provide a reference date for citing the service description Format is "yyyy-mm-dd" | Mandatory |
Example
"descriptionInformation": { "serviceDescriptionIdentification": { "serviceDescriptionTitle": "Donlon TOBT Setting Service Description", "serviceDescriptionEdition": "0.93i", "serviceDescriptionReferenceDate": "2020-06-02" } }
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.