| 1 | # Context Schema
|
| 2 |
|
| 3 | ```txt
|
| 4 | https://ns.adobe.com/helix/pipeline/context
|
| 5 | ```
|
| 6 |
|
| 7 | The context thingie.
|
| 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 | [context.schema.json](context.schema.json "open original schema") |
|
| 13 |
|
| 14 | ## Context Type
|
| 15 |
|
| 16 | `object` ([Context](context.md))
|
| 17 |
|
| 18 | # Context Properties
|
| 19 |
|
| 20 | | Property | Type | Required | Nullable | Defined by |
|
| 21 | | :-------------------- | ------------ | -------- | -------------- | :----------------------------------------------------------------------------------------------------------------- |
|
| 22 | | [error](#error) | Unknown Type | Optional | cannot be null | [Context](context-properties-error.md "https://ns.adobe.com/helix/pipeline/context#/properties/error") |
|
| 23 | | [request](#request) | `object` | Optional | cannot be null | [Context](context-properties-request.md "https://ns.adobe.com/helix/pipeline/request#/properties/request") |
|
| 24 | | [content](#content) | `object` | Optional | cannot be null | [Context](context-properties-content.md "https://ns.adobe.com/helix/pipeline/content#/properties/content") |
|
| 25 | | [response](#response) | `object` | Optional | cannot be null | [Context](context-properties-response.md "https://ns.adobe.com/helix/pipeline/response#/properties/response") |
|
| 26 |
|
| 27 | ## error
|
| 28 |
|
| 29 | An error message that has been generated during pipeline processing.
|
| 30 | When this property is present, all other values can be ignored.
|
| 31 |
|
| 32 |
|
| 33 | `error`
|
| 34 |
|
| 35 | - is optional
|
| 36 | - Type: any of the folllowing: `string` or `object` ([Details](context-properties-error.md))
|
| 37 | - cannot be null
|
| 38 | - defined in: [Context](context-properties-error.md "https://ns.adobe.com/helix/pipeline/context#/properties/error")
|
| 39 |
|
| 40 | ### error Type
|
| 41 |
|
| 42 | any of the folllowing: `string` or `object` ([Details](context-properties-error.md))
|
| 43 |
|
| 44 | ## request
|
| 45 |
|
| 46 | The HTTP Request
|
| 47 |
|
| 48 |
|
| 49 | `request`
|
| 50 |
|
| 51 | - is optional
|
| 52 | - Type: `object` ([Request](context-properties-request.md))
|
| 53 | - cannot be null
|
| 54 | - defined in: [Context](context-properties-request.md "https://ns.adobe.com/helix/pipeline/request#/properties/request")
|
| 55 |
|
| 56 | ### request Type
|
| 57 |
|
| 58 | `object` ([Request](context-properties-request.md))
|
| 59 |
|
| 60 | ## content
|
| 61 |
|
| 62 | The content as retrieved from the repository and enriched in the pipeline.
|
| 63 |
|
| 64 |
|
| 65 | `content`
|
| 66 |
|
| 67 | - is optional
|
| 68 | - Type: `object` ([Content](context-properties-content.md))
|
| 69 | - cannot be null
|
| 70 | - defined in: [Context](context-properties-content.md "https://ns.adobe.com/helix/pipeline/content#/properties/content")
|
| 71 |
|
| 72 | ### content Type
|
| 73 |
|
| 74 | `object` ([Content](context-properties-content.md))
|
| 75 |
|
| 76 | ## response
|
| 77 |
|
| 78 | The HTTP response object
|
| 79 |
|
| 80 |
|
| 81 | `response`
|
| 82 |
|
| 83 | - is optional
|
| 84 | - Type: `object` ([Response](context-properties-response.md))
|
| 85 | - cannot be null
|
| 86 | - defined in: [Context](context-properties-response.md "https://ns.adobe.com/helix/pipeline/response#/properties/response")
|
| 87 |
|
| 88 | ### response Type
|
| 89 |
|
| 90 | `object` ([Response](context-properties-response.md))
|