Profile: internal-link

Profile Schema

An internal-link document contains a link to a CDS-provided document.

Structure

The internal-link profile requires a documentLink link object to be present. This link must be a relative link to a CDS document, and should start with /v1/documents/. This link does not necessarily have to be valid; it may result in a 404 or other error from CDS. documentLink should have no rels.

In addition, internal-link allows for two optional attributes:

• linkText - Text that should be used to display this link
• linkLabel - DEPRECATED - Text that should be displayed contextually, in addition to the link itself

Example internal-link document

{
  "id": "12345",
  "profiles": [
    {
      "href": "/v1/profiles/internal-link",
      "rels": [
        "type"
      ]
    },
    {
      "href": "/v1/profiles/document"
    }
  ],

  "documentLink": {
    "href": "/v1/documents/7890"
  },
  "linkText": "Related Story: Jay Garrick, the first Flash",
  "linkLabel": "We all know Wally West, but who was the first Flash? Meet Jay Garrick, the original speedster standard bearer"
}