Skip to content

ProviderDiscoveredRoute

HTTP API schema

← HTTP API reference

Provider input before host synchronization assigns persisted route identity and ownership. Canonical provider facts reuse Route property definitions. The Go projection reuses the Route wire adapter; validation uses this input schema, not persisted Route. Host identity fields may be omitted or empty and never establish authenticated publisher or installation authority. Nonempty id and associatedEndpointId may select an existing authorized route during scoped rediscovery; newly created routes and endpoints receive host-assigned IDs.

ProviderDiscoveredRoute fields

associatedPluginRouteIdstringRequired

The stable plugin-owned route identifier associated with this Port OS route. For synchronized plugin capability contracts and fixture parity checks, use this field to match a route from enumeration back to the discovery payload.

minLength: 1

externalIdexternalId

externalId: Reference externalId

pluginProfileIdpluginProfileId

pluginProfileId: Reference pluginProfileId

interfacesinterfacesRequired

interfaces: Reference interfaces

ontologicalTypesontologicalTypesRequired

ontologicalTypes: Reference ontologicalTypes

namename

name: Reference name

descriptiondescription

description: Reference description

manufacturermanufacturer

manufacturer: Reference manufacturer

modelmodel

model: Reference model

serialNumberserialNumber

serialNumber: Reference serialNumber

pluginCustomMetadatapluginCustomMetadata

pluginCustomMetadata: Reference pluginCustomMetadata

idstring

Advisory value, including empty. Together with associatedEndpointId it may select an existing route within the authenticated scope. New persisted IDs are assigned by the host and validated by the separate persisted Route schema.

associatedPluginIdassociatedPluginId

associatedPluginId: Reference associatedPluginId

associatedAuthLinkIdassociatedAuthLinkId

associatedAuthLinkId: Reference associatedAuthLinkId

associatedEndpointIdassociatedEndpointId

associatedEndpointId: Reference associatedEndpointId

View source specification ↗