| 1 | # Content Schema
|
| 2 |
|
| 3 | ```txt
|
| 4 | https://ns.adobe.com/helix/pipeline/content
|
| 5 | ```
|
| 6 |
|
| 7 | The content as retrieved from the repository and enriched in the pipeline.
|
| 8 |
|
| 9 |
|
| 10 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
| 11 | | :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- |
|
| 12 | | Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [content.schema.json](content.schema.json "open original schema") |
|
| 13 |
|
| 14 | ## Content Type
|
| 15 |
|
| 16 | `object` ([Content](content.md))
|
| 17 |
|
| 18 | # Content Properties
|
| 19 |
|
| 20 | | Property | Type | Required | Nullable | Defined by |
|
| 21 | | :-------------------- | ------------ | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------- |
|
| 22 | | [sources](#sources) | `array` | Optional | cannot be null | [Content](content-properties-sources.md "https://ns.adobe.com/helix/pipeline/content#/properties/sources") |
|
| 23 | | [body](#body) | `string` | Optional | cannot be null | [Content](content-properties-body.md "https://ns.adobe.com/helix/pipeline/content#/properties/body") |
|
| 24 | | [mdast](#mdast) | `object` | Optional | cannot be null | [Content](content-properties-mdast.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/mdast") |
|
| 25 | | [document](#document) | `object` | Optional | cannot be null | [Content](content-properties-document.md "https://ns.adobe.com/helix/pipeline/content#/properties/document") |
|
| 26 | | [json](#json) | `object` | Optional | cannot be null | [Content](content-properties-json.md "https://ns.adobe.com/helix/pipeline/content#/properties/json") |
|
| 27 | | [xml](#xml) | `object` | Optional | cannot be null | [Content](content-properties-xml.md "https://ns.adobe.com/helix/pipeline/content#/properties/xml") |
|
| 28 | | [meta](#meta) | Unknown Type | Optional | can be null | [Content](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/content#/properties/meta") |
|
| 29 | | [title](#title) | `string` | Optional | cannot be null | [Content](content-properties-title.md "https://ns.adobe.com/helix/pipeline/content#/properties/title") |
|
| 30 | | [intro](#intro) | `string` | Optional | cannot be null | [Content](content-properties-intro.md "https://ns.adobe.com/helix/pipeline/content#/properties/intro") |
|
| 31 | | [image](#image) | `string` | Optional | cannot be null | [Content](content-properties-image.md "https://ns.adobe.com/helix/pipeline/content#/properties/image") |
|
| 32 | | [data](#data) | `object` | Optional | cannot be null | [Content](content-properties-data.md "https://ns.adobe.com/helix/pipeline/content#/properties/data") |
|
| 33 |
|
| 34 | ## sources
|
| 35 |
|
| 36 | List of URIs that have been retrieved for this piece of content
|
| 37 |
|
| 38 |
|
| 39 | `sources`
|
| 40 |
|
| 41 | - is optional
|
| 42 | - Type: `string[]`
|
| 43 | - cannot be null
|
| 44 | - defined in: [Content](content-properties-sources.md "https://ns.adobe.com/helix/pipeline/content#/properties/sources")
|
| 45 |
|
| 46 | ### sources Type
|
| 47 |
|
| 48 | `string[]`
|
| 49 |
|
| 50 | ## body
|
| 51 |
|
| 52 | The content body of the retrieved source document
|
| 53 |
|
| 54 |
|
| 55 | `body`
|
| 56 |
|
| 57 | - is optional
|
| 58 | - Type: `string`
|
| 59 | - cannot be null
|
| 60 | - defined in: [Content](content-properties-body.md "https://ns.adobe.com/helix/pipeline/content#/properties/body")
|
| 61 |
|
| 62 | ### body Type
|
| 63 |
|
| 64 | `string`
|
| 65 |
|
| 66 | ## mdast
|
| 67 |
|
| 68 | A node in the Markdown AST
|
| 69 |
|
| 70 |
|
| 71 | `mdast`
|
| 72 |
|
| 73 | - is optional
|
| 74 | - Type: `object` ([MDAST](content-properties-mdast.md))
|
| 75 | - cannot be null
|
| 76 | - defined in: [Content](content-properties-mdast.md "https://ns.adobe.com/helix/pipeline/mdast#/properties/mdast")
|
| 77 |
|
| 78 | ### mdast Type
|
| 79 |
|
| 80 | `object` ([MDAST](content-properties-mdast.md))
|
| 81 |
|
| 82 | ## document
|
| 83 |
|
| 84 | The DOM-compatible representation of the document's inner HTML
|
| 85 |
|
| 86 |
|
| 87 | `document`
|
| 88 |
|
| 89 | - is optional
|
| 90 | - Type: `object` ([Details](content-properties-document.md))
|
| 91 | - cannot be null
|
| 92 | - defined in: [Content](content-properties-document.md "https://ns.adobe.com/helix/pipeline/content#/properties/document")
|
| 93 |
|
| 94 | ### document Type
|
| 95 |
|
| 96 | `object` ([Details](content-properties-document.md))
|
| 97 |
|
| 98 | ## json
|
| 99 |
|
| 100 | The JSON object to emit.
|
| 101 |
|
| 102 |
|
| 103 | `json`
|
| 104 |
|
| 105 | - is optional
|
| 106 | - Type: `object` ([Details](content-properties-json.md))
|
| 107 | - cannot be null
|
| 108 | - defined in: [Content](content-properties-json.md "https://ns.adobe.com/helix/pipeline/content#/properties/json")
|
| 109 |
|
| 110 | ### json Type
|
| 111 |
|
| 112 | `object` ([Details](content-properties-json.md))
|
| 113 |
|
| 114 | ## xml
|
| 115 |
|
| 116 | The XML object to emit. See xmlbuilder-js for syntax.
|
| 117 |
|
| 118 |
|
| 119 | `xml`
|
| 120 |
|
| 121 | - is optional
|
| 122 | - Type: `object` ([Details](content-properties-xml.md))
|
| 123 | - cannot be null
|
| 124 | - defined in: [Content](content-properties-xml.md "https://ns.adobe.com/helix/pipeline/content#/properties/xml")
|
| 125 |
|
| 126 | ### xml Type
|
| 127 |
|
| 128 | `object` ([Details](content-properties-xml.md))
|
| 129 |
|
| 130 | ## meta
|
| 131 |
|
| 132 |
|
| 133 |
|
| 134 |
|
| 135 | `meta`
|
| 136 |
|
| 137 | - is optional
|
| 138 | - Type: `object` ([Details](meta-definitions-meta.md))
|
| 139 | - can be null
|
| 140 | - defined in: [Content](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/content#/properties/meta")
|
| 141 |
|
| 142 | ### meta Type
|
| 143 |
|
| 144 | `object` ([Details](meta-definitions-meta.md))
|
| 145 |
|
| 146 | ## title
|
| 147 |
|
| 148 | Extracted title of the document
|
| 149 |
|
| 150 |
|
| 151 | `title`
|
| 152 |
|
| 153 | - is optional
|
| 154 | - Type: `string`
|
| 155 | - cannot be null
|
| 156 | - defined in: [Content](content-properties-title.md "https://ns.adobe.com/helix/pipeline/content#/properties/title")
|
| 157 |
|
| 158 | ### title Type
|
| 159 |
|
| 160 | `string`
|
| 161 |
|
| 162 | ## intro
|
| 163 |
|
| 164 | Extracted first paragraph of the document
|
| 165 |
|
| 166 |
|
| 167 | `intro`
|
| 168 |
|
| 169 | - is optional
|
| 170 | - Type: `string`
|
| 171 | - cannot be null
|
| 172 | - defined in: [Content](content-properties-intro.md "https://ns.adobe.com/helix/pipeline/content#/properties/intro")
|
| 173 |
|
| 174 | ### intro Type
|
| 175 |
|
| 176 | `string`
|
| 177 |
|
| 178 | ## image
|
| 179 |
|
| 180 | Path (can be relative) to the first image in the document
|
| 181 |
|
| 182 |
|
| 183 | `image`
|
| 184 |
|
| 185 | - is optional
|
| 186 | - Type: `string`
|
| 187 | - cannot be null
|
| 188 | - defined in: [Content](content-properties-image.md "https://ns.adobe.com/helix/pipeline/content#/properties/image")
|
| 189 |
|
| 190 | ### image Type
|
| 191 |
|
| 192 | `string`
|
| 193 |
|
| 194 | ### image Constraints
|
| 195 |
|
| 196 | **URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification")
|
| 197 |
|
| 198 | ## data
|
| 199 |
|
| 200 | Custom object that can hold any user defined data.
|
| 201 |
|
| 202 |
|
| 203 | `data`
|
| 204 |
|
| 205 | - is optional
|
| 206 | - Type: `object` ([Details](content-properties-data.md))
|
| 207 | - cannot be null
|
| 208 | - defined in: [Content](content-properties-data.md "https://ns.adobe.com/helix/pipeline/content#/properties/data")
|
| 209 |
|
| 210 | ### data Type
|
| 211 |
|
| 212 | `object` ([Details](content-properties-data.md))
|