Arrowhead 5.0 review disscussion - Documentation Tracking

[rbocsi]

We have a lot of draft documentation. All documentation have a dedicated issue where people can comment them. However, it is not easy to follow which issues are related. This tracking issue provides shortcuts to make things easier.

Please note that we have updated all documentation links to the current version.

General

• SD - general-management: SD 5.0 review discussion - general-management #94

Service Registry

• SysD: SysD 5.0 review discussion - ServiceRegistry #75
• SD - device-discovery: SD 5.0 review discussion - device-discovery #95
• SD - system-dicovery: SD 5.0 review discussion - system-discovery #96
• SD - service-discovery: SD 5.0 review discussion - service-discovery #97
• SD - service-registry-management: SD 5.0 review discussion - service-registry-management #98

Authentication

• SysD: SysD 5.0 review discussion - Authentication #99
• SD - identity: SD 5.0 review discussion - identity #100
• SD - identity-management: SD 5.0 review discussion - identity-management #101

Service Orchestration

• SysD: SysD 5.0 review discussion - ServiceOrchestration #76

Authorization

• SysD: SysD 5.0 review discussion - Authorization #77

@jerkerdelsing @palvarga @tottthy2

[borditamas]

Draft IDDs are available here.

[jerkerdelsing]

SysD ServiceRegistry 1.3.1
inconsistent description of the serviceDiscovery compared to the SD serviceDiscovery

IDD serviceDiscovery

Suggestion for a more polished documentation

%Service operation request
POST /ServiceRegistry/serviceDiscovery/register HTTP/1.1
Authorization: Bearer

% ServiceRegistrationRequest
%================ JSON encoded body
{
"serviceDefinitionName": "kelvin-info",
"version": "",
"expiresAt": "2030-01-01T00:00:00Z",
"metadata":
{
"margin-of-error": 0.5
},
"interfaces":
[
{
"templateName": "generic-http",
"protocol": "http",
"policy": "NONE",
"properties":
{
"accessAddresses": ["192.168.56.116", "tp2.greenhouse.com"]
"accessPort": 8080,
"basePath": "/kelvin",
"operations": {"query-temperature": { "method": "GET", "path": "/query"} }
}
}
]
% Should be included
“ownerSystemName”: “TemperatureSystem2”
}
%============== end of JSON encoded body

%ServcieRegistrationResonse

……

%SystemRegistrationRequest

POST /serviceregistry/system-discovery/register HTTP/1.1
Authorization: Bearer

% ServiceRegistrationRequest
%================ JSON encoded body
{
"metadata": {
"scales": ["Kelvin", "Celsius"],
"location": {"side": "North", "block": 2},
"indoor": true
},
"version": "",
"addresses": [
"192.168.56.116",
"tp2.greenhouse.com"
],
"deviceName": "thermometer2"
}

SD serviceRegistryManagement

2.8 operation system-remove (systemRemoveRequest) : operationStatus / errorResponse
Definition text missing

2.9 operation serviceDefinitionQuery (serviceDefinitionListRequest) : serviceDefinitionListResponse / errorResponse

2.11 operation service-definition-remove (ServiceDefinitionRemoveRequest) : OperationStatus / ErrorResponse
Definition text missing

2.16 operation interfaceTemplateQuery (interfaceTemplateQueryRequest) : interfaceTemplateQueryResponse / ErrorResponse

2.18 operation interface-template-remove (InterfaceTemplateRemoveRequest) : OperationStatus / ErrorResponse
Definition text missing

[borditamas]

@jerkerdelsing

inconsistent description of the serviceDiscovery compared to the SD serviceDiscovery

Could you please detail it?

Should be included “ownerSystemName”: “TemperatureSystem2”

Owner system comes from the provided identity info. No need to repeat it in the json payload.

Definition text missing

Ok, we going to correct it.