UNPKG

@adobe/helix-pipeline

Version:

This project provides helper functions and default implementations for creating Hypermedia Processing Pipelines.

github.com/adobe/helix-pipeline

adobe/helix-pipeline

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