| Panel | ||
|---|---|---|
| ||
|
| Info | ||
|---|---|---|
| ||
This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-021 Service operations |
Requirement
| Panel | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Guidance
The specification allows flexibility in describing the technical view of the interactions with the service. This is illustrated below. For example:
- some service designs do not rely on interfaces or operations for their interactions.
- it is possible to define input and output message as part of service interfaces when no operations are exposed.
-
HTHTTP error codes are covered by SWIM-SERV-220 Service behaviour. The Examples/Notes in the requirement box suggests that they are covered in the detailed model view. However, there is nothing in the service metadata schema to stop you adding a new behaviour field with a name set to, e.g., “Error Handling”.
Verification Support
| Completeness | Check that: [ ] The service description includes or refers to information about the input messages that are exchanged by the service. [ ] The service description includes or refers to information about the output messages that are exchanged by the service. [ ] The service description includes or refers to information about the error messages that are exchanged by the service. |
Examples
The following example shows the content as a table.
service messages | message | name | TOBTSettingRequest |
|---|---|---|---|
| description | Message which provides the Target Off-Block Time value of a specific flight. | ||
| data format | https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd | ||
| message | name | TOBTSettingResponse | |
| description | Message which responds the validity of a previously sent TOBTSettingRequest message. | ||
| data format | https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd | ||
| message | name | TOBTDeleteRequest | |
| description | Message which requests deleting the last TOBT value of the specified flight. | ||
| data format | https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd | ||
| message | name | TOBTDeleteResponse | |
| description | Message which responds the validity of a previously sent TOBTDeleteRequest message. | ||
| data format | https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd | ||
| message | name | TOBTTimeError | |
| description | The time used in the query is not valid. | ||
| data format | https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd | ||
| isError | true |
The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema
| Info |
|---|
The example contains the schema field for completeness. This is required by SWIM-SERV-260 Service interface protocols and data format. |
| Code Block | ||||
|---|---|---|---|---|
| ||||
"serviceInterface": [{
"messages": [{
"name": "TOBTSettingRequest",
"description": "Message which provides the Target Off-Block Time value of a specific flight.",
"schema": {
"url": "https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd" } },
{
"name": "TOBTSettingResponse",
"description": "Message which responds the validity of a previously sent TOBTSettingRequest message.",
"schema": { "url": "https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd" } },
{
"name": "TOBTDeleteRequest",
"description": "Message which requests deleting the last TOBT value of the specified flight.",
"schema": { "url": "https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd" } },
{
"name": "TOBTDeleteResponse",
"description": "Message which responds the validity of a previously sent TOBTDeleteRequest message.",
"schema": { "url": "https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd" }
},
{
"name": "TOBTTimeError",
"description" : "The time used in the query is not valid.",
"schema": {
"url": "https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd"
},
"isError": true
}
]
}] |
Complete examples are available at Example service description.