Ongoing discussions within the SWIM communities of interest

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Excerpt Include
Task Status
Task Status
nopaneltrue

Excerpt

This page handles FAQ answers that are a work in progress.

Table of Contents

Current FAQ

Updates

Panel

How do I describe a service that uses GraphQL?

GraphQL is allowed using HTTP as the transport layer (i.e. using WS-Light binding in SWIM-SERV-018 TI Profile and bindings).

GraphQL is an example of message-oriented service design (as opposed to operation-oriented or resource-oriented service design). For message-oriented services, the essential part is describing the data schema. GraphQL services do this in its own schema language “GraphQL Schema Language”.

Work is being carried out at https://gist.github.com/kouak/8a13bb2730b91a797ca3354e56587f71

Panel

How is the quality of service documented at various service lifecycle stages?

How do I document quality of service in a service definition?

A service definition sets out community agreed requirements on the service to be implemented. The community can be strict or less strict with the requirements.  Therefore, the quality of service requirements can:

  • be left abstract (e.g. "The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.");  or
  • give a minimum to be reached by all service providers, in which case the guidance set out in SWIM-SERV-180 Quality of service for service descriptions can be applied. For example:
    • "The service shall support a capacity of at least 2000 service requests per hour."

If the requirements are left at the abstract level, implementers have freedom to define their own concrete quality of service parameters. The service description will then describe the concrete parameters.

How do I document quality of service in a service description?

See SWIM-SERV-180 Quality of service.

Panel

How is the quality of data documented at various service lifecycle stages?

How do I document quality of data in a service definition?

The items used to describe quality of data vary between information domains. They may include, for example, accuracy, resolution and precision.

A service definition sets out community agreed requirements on the service to be implemented. The community can be strict or less strict with the requirements.  Therefore, the quality of data requirements can:

  • be left abstract; or
  • give a minimum to be ensured by all service providers either by including requirements or making reference to them.

If the requirements are left at the abstract level, implementers have freedom to define their own concrete quality of data.

Requirements may be found in:

  • ICAO documents. For example, "The data shall meet the data quality requirements outlined in the PANS-AIM Data Catalogue".
  • EU regulations. For example, "The aeronautical data offered by the service shall satisfy the applicable sections of Commission Implementing Regulation (EU) 2017/373 of 1 March 2017".
  • community agreed requirements such as AIXM coding guidelines

How do I document quality of data in a service description?

There is no requirement to document the quality of data in a service description. However, it can be added if needed and help inform the negotiations of the "formal arrangement" in a similar way to the quality of service parameters as explained at Formal Arrangements - Service Level Agreements.

SWIM-SERV-190 Source of information is used to record modifications that have happened to the information.