Discovery

This doc specifies the Messages to be used when interacting with the Discovery component integrated in runtime core, where,

<userIdentifier> can be the user address compliant with UserURL data model. Example: user://example.com/bob. Or can be a email address.
<registry-object-type> is either dataobject or hyperty
<registry-object-url> is either dataobject or hyperty URL.

Hyperty URL example: hyperty://mydomain/12345-qwert

Data Object URL example: comm://mydomain/12345-qwert
<discoveredRegistryObjects> can be a JSON object compliant with HypertyInstance data model or a JSON object compliant with HypertyDataObjectInstance data model.
<user-profile-attribute-value> is a value of an attribute present on the profile of the user in Discovery Service component.

Discover Hyperties/DataObjects by User URL or Email

Querying the Domain Registry with a user identifier (either in url or email format). Optionally also with types of hyperties/dataObjects schemas (e.g. comasdm), types of hyperties/dataObjects resources (e.g. chat) and domain.

Request to Discovery component:

"id"   : 1
"type" : "read",
"from" : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"to"   : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"body" : { "resource" : "/<registry-object-type>/user/<userIdentifier>", "criteria" : { "resources" : ["<resources>"], "dataSchemes" : ["<schema>"], "domain" : "domain" }}

Response from Discovery component:

"id"   : 1
"type" : "response",
"from" : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"to"   : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"body" : { "code" : 200, "value" : ["<discoveredRegistryObjects>"] }

Not Found Response from Discovery component:

"id"   : 1
"type" : "response",
"from" : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"to"   : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"body" : { "code" : 404, "description" : "Not Found" }

Discover Hyperty/DataObject by DataObject/Hyperty URL

Querying the Domain Registry with a registry object URL (Hyperty or DataObject).

Request to Discovery component:

"id"   : 4
"type" : "read",
"from" : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"to"   : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"body" : { "resource" : "/<registry-object-type>/url/<registry-object-url>", "criteria": {"domain" : "domain" }}

Response from Discovery component:

"id"   : 4
"type" : "response",
"from" : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"to"   : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"body" : { "code" : 200, "value" : "<RegistryDataObject>" }

Not Found Response from Discovery component:

"id"   : 4
"type" : "response",
"from" : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"to"   : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"body" : { "code" : 404, "description" : "Not Found" }

Discover DataObjects by DataObject Name

Querying the Domain Registry with a dataObject name. Optionally also with types of dataObject schemas (e.g. comasdm), types of dataObject resources (e.g. chat).

Request to Discovery component:

"id"   : 5
"type" : "read",
"from" : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"to"   : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"body" : { "resource" : "/<registry-object-type>/name/<dataObjtName>", "criteria" : { "resources" : ["<resources>"], "dataSchemes" : ["<schema>"], "domain" : "domain" }}

Response from Discovery component:

"id"   : 5
"type" : "response",
"from" : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"to"   : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"body" : { "code" : 200, "value" : ["<discoveredRegistryObjects>"] }

Not Found Response from Discovery component:

"id"   : 5
"type" : "response",
"from" : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"to"   : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"body" : { "code" : 404, "description" : "Not Found" }

Discover DataObjects by Reporter

Querying the Domain Registry with a reporter url (hyperty). Optionally also with types of dataObject schemas (e.g. comasdm), types of dataObject resources (e.g. chat).

Request to Discovery component:

"id"   : 5
"type" : "read",
"from" : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"to"   : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"body" : { "resource" : "/<registry-object-type>/reporter/<registry-object-url>", "criteria" : { "resources" : ["<resources>"], "dataSchemes" : ["<schema>"], "domain" : "domain" }}

Response from Discovery component:

"id"   : 5
"type" : "response",
"from" : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"to"   : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"body" : { "code" : 200, "value" : ["<discoveredRegistryObjects>"] }

Not Found Response from Discovery component:

"id"   : 5
"type" : "response",
"from" : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"to"   : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"body" : { "code" : 404, "description" : "Not Found" }

Discover Hyperties/DataObjects by GUID

First, querying the Global Registry with a GUID and then querying the Domain Registry with the associated uIDs. Optionally also with types of hyperties/dataObjects schemas (e.g. comasdm) and types of hyperties/dataObjects resources (e.g. chat).

Request to Discovery component:

"id"   : 7
"type" : "read",
"from" : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"to"   : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"body" : { "resource" : "/<registry-object-type>/guid/<GuidURL>", "criteria" : { "resources" : ["<resources>"], "dataSchemes" : ["<schema>"] }}

Response from Discovery component:

"id"   : 7
"type" : "response",
"from" : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"to"   : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"body" : { "code" : 200, "value" : ["<discoveredRegistryObjects>"] }

Not Found Response from Discovery component:

"id"   : 7
"type" : "response",
"from" : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"to"   : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"body" : { "code" : 404, "description" : "Not Found" }

Discover Hyperties/DataObjects by Profile Data

First, querying the Discovery Service with some Profile Data (i.e. username). Second, querying Global Registry with the associated GUIDs and then querying the Domain Registry with the associated uIDs. Optionally also with types of hyperties/dataObjects schemas (e.g. comasdm) and types of hyperties/dataObjects resources (e.g. chat).

Request to Discovery component:

"id"   : 7
"type" : "read",
"from" : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"to"   : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"body" : { "resource" : "/<registry-object-type>/userprofile/<user-profile-attribute-value>", "criteria" : { "resources" : ["<resources>"], "dataSchemes" : ["<schema>"] }}

Response from Discovery component:

"id"   : 7
"type" : "response",
"from" : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"to"   : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"body" : { "code" : 200, "value" : ["<discoveredRegistryObjects>"] }

Not Found Response from Discovery component:

"id"   : 7
"type" : "response",
"from" : "runtime://<sp-domain>/<runtime-instance-identifier>/discovery/",
"to"   : "hyperty://<sp-domain>/<hyperty-instance-identifier>",
"body" : { "code" : 404, "description" : "Not Found" }