markspec/link-target/v1.json

Shared object for resolved link endpoints.

Schema URL: https://driftsys.github.io/schemas/markspec/link-target/v1.json

The link-target object is a shared definition used across multiple schemas (entry, reference, traceability matrix, BOM, deps) to represent a resolved link to another entry. It carries the target's display ID, title, and URL, plus an optional project object for cross-project links with PURL identification.

Quick guide

Properties

PathTypeRequiredDescription
displayIdstringyesHuman-readable display ID of the target entry
titlestringyesTitle of the target entry
urlstringyesRelative URL to the target entry's page
entryTypestringEntry type abbreviation (absent for references)
projectobjectPresent only for cross-project links
project.namestringyesCanonical reverse-DNS project ID
project.purlstringPackage URL (PURL) for the external project
project.urlstringURL to the external project's site root

Common pitfall

Do not assume entryType is present for references.