Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
UNDERWORK
JSON Guidance related to Service Overview
This is guidance for producing JSON service descriptions related to satisfying the needs identified in the ICAO notion of Service Overview.
Requirement
Identifier | SERV-OVW-017 |
Field name | Sources of Information |
Detailed content | A description of the origins of information provided by the information service along with an indication whether there were any subsequent modifications. |
Template | Free text |
Example | NIL |
Rationale and Guidance | Rationale: Provide the user with background on information source and modifications. Guidance: Specify origin of the information, and if any modifications were applied by the information service provider. |
Level of Implementation | Optional |
Guidance
N/A
Guidance for JSON service description
Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
Guidance
tip
Including the "Sources of information" is optional. Absence of this information needs not be motivated.
Case 1 - Sources are included
info
The JSON schema does not provide specific attributes to capture this information. As a consequence the Concept structure within the schema will be used.
See more on the concept structure in SWIM-SERV-ADD Additional info.
Use the Concept structure to describe the sources of information.
attribute | content | rule |
---|---|---|
name | "Sources of information" | Mandatory |
description | Specify origin of the information, and if any modifications were applied by the information service provider. | Mandatory |
Case 2 - Sources are not included
Nothing has to be provided.
Example
"serviceGeneralDescription": { "concepts": [ { "name": "Sources of information", "description": "... description here ..." } ]
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.