Working towards the next version of the SWIM Supporting Material

Page tree

Working towards the next version of the SWIM Supporting Material

Skip to end of metadata
Go to start of metadata

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
or NIL

ExampleNIL
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

tentative JSON Guidance

Schema

The guidance concerns JSON Schema v0.0.3 (see Schema releases). 

 Schema excerpt [+]

The schema does NOT foresee an explicit field for describing filter capabilities. To cope with this shortcoming, the Concept type planned for optional information is used.

	
		"ServiceGeneralDescription" : 
		{
			"description" : "Description of the service in terms of what it provides, the purpose and under which conditions and quality levels the service is provided.",
			"type": "object",
			"additionalProperties": false,
			"required": ["operationalNeed", "functionality", "qualityOfService", "accessAndUseCondition", "validation"],
			"properties":
			{
				...
				"concepts":
				{
					"description" : "Optional information intended for a good understanding of the service. This may cover design concepts related to the service, logical model, design considerations, or any other information not pertaining to the other fields.",
					"type" : "array",
					"items" : { "$ref":"#/definitions/Concept" }
				},
				...
			}
		},


		"Concept" : 
		{
			"description" : "Optional information intended for a good understanding of the service. This may cover design concepts related to the service, logical model, design considerations, or any other information not pertaining to the other fields.",
			"type": "object",
			"additionalProperties": false,
			"required": ["name", "description"],
			"properties":
			{
				"description":
				{
					"description" : "Description of the concept.",
					"type" : "string",
					"minLength":1
				},
				"name":
				{
					"description" : "The name of the concept.",
					"type" : "string",
					"minLength":1
				}
			}
		},
 Rules [+]

This is optional information.

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. 

attributecontentrule
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

case 1 - sources are included
		"serviceGeneralDescription": {
			
			"concepts": [
				{
					"name": "Sources of information",
					"description": "... description here ..."
				}
			]
case 2 - sources are not included
 

A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.

  • No labels