OutOfProcessReferenceResolver.ResponseV2.resolved(_:)

A response with the resolved information about the requested link or symbol.

case resolved(LinkDestinationSummary)

Discussion

The referenceURL can have a “path” and “fragment” components that are different from what DocC sent in the OutOfProcessReferenceResolver.RequestV2.link(_:) request. For example; if your resolver supports different spellings of the link—corresponding to a page’s different names in different language representations—you can return the common reference URL identifier for that page for all link spellings.

Note
DocC expects the resolved referenceURL to have a “host” component that matches the DocumentationBundle.Identifier that your resolver provided in its initial OutOfProcessReferenceResolver.ResponseV2.identifierAndCapabilities(_:_:) handshake message. Responding with a referenceURL that doesn’t match the resolver’s provided DocumentationBundle.Identifier is undefined behavior.