Skip to content
GitmoapAPIBeta
Schema

SpecRef

One cross-reference, and what it resolved to.

Shape

  • doc_idstring
  • lineinteger · int32
  • rawstring
  • ref_kindSpecRefKinddocumentsectionanchoridentifiercodeoperationThe form a cross-reference took in the source.
  • resolvedboolean
  • anchorstring or nulloptional
  • target_anchorstring or nulloptional
  • target_doc_idstring or nulloptional
  • target_idstring or nulloptional
  • target_methodstring or nulloptional
  • target_pathstring or nulloptional
  • target_sectionstring or nulloptional

Example

Synthesized example
{
"doc_id": "47fe4d02-054d-4da2-a14c-6f19d0682080",
"line": 77,
"raw": "raw-5020",
"ref_kind": "document",
"resolved": false,
"anchor": "anchor-aa8c",
"target_anchor": "target-anchor-b355",
"target_doc_id": "a689c1ec-f4de-4fec-bb8a-262ceabb7195",
"target_id": "341d5046-f924-484b-86d0-78f574e44e17",
"target_method": "target-method-ad8d",
"target_path": "target-path-2e8c",
"target_section": "target-section-6798"
}

Graph

Used inside

No schema contains this one.

Contains

No named schema inside.

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 0 operations

No operation returns it directly.