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


Requirement

Title

Service abstract

Identifier

SWIM-SERV-007

Requirement

A service description shall include an abstract as a small textual description in plain language summarising the service.

Rationale

A good abstract is valuable, in particular during service discovery.

This requirement supports the decisions on whether the described service is suitable for use in a particular situation.

Verification

Completeness: Verify that the element is included.

Consistency: Not Applicable.

Correctness: Not Applicable. 

Examples/Notes

Note: It is best practice for an abstract to summarise the information provided elsewhere in the service description and not to bring any new information.

Level of Implementation

Mandatory


Guidance

Examples

See the Service Abstract section within the Donlon TOBT Setting Service Description.

Guidance for JSON service description 

tentative JSON Guidance

Schema

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

 Schema excerpt [+]
		"informationService":
		{
			"description" : "the description of an information service [SWIM-SERV-001]",
			"$ref" :  "#/definitions/InformationService"
		}

		"InformationService" : 
		{
			"description" : "A type of service that provides an ATM information sharing capability.",
			"type": "object",
			"additionalProperties": false,
			"required": ["descriptionInformation", "name", "version", "serviceAbstract", "serviceProvision", "serviceCategorisation", "serviceGeneralDescription", "serviceInformationDescription", "serviceTechnicalDescription", "serviceDescriptionReferences", "serviceInterface"],
			"properties":
			
				"serviceAbstract":
				{
					"description" : "A brief summary of the service offering. [SWIM-SERV-007]",
					"type" : "string",
					"minLength":1
				}

			}
		}
 Rules [+]

Rules expressed for the cases as defined in Registry URD.

caserules
COMPLIANTMandatory
CANDIDATEsame
DEFINITIONsame

Guidance

Within field informationService, fill in the following attribute


attributetypedescriptionguidancerule
serviceAbstractstringA brief summary of the service offering.

Provide a textual description in plain language summarising the service.

Consider to include or introduce:

  • the operational context supported
  • the operational need being addressed by the service
  • the intended use of the service
  • the intended consumer audience for the service
  • the geographical extent
  • the service's first date of operation. Eg "XXX service is in operation since yyyy-mm-dd".
Mandatory

Example

	"informationService": {
		
		"serviceAbstract": "The TargetOffBlockTimeSetting service supports the Airport CDM concept and its implementation by allowing A-CDM Partners, typically aircraft operators and ground handlers, with the capability to set the Target Off-Block Time (TOBT) that indicates the target time for the aircraft to be ready for Off-Block.It is part of a set of services supporting the Airport CDM concept and its implementation by providing the A-CDM partners with Common Situation Awareness about flights at a CDM airport.\r\nThis is an example of Service Description for a fictitious service, with the intention to illustrate the Registry in development.",
		
		}


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

  • No labels