UNPKG

@adobe/helix-pipeline

Version:

(formerly known as Hypermedia Pipeline)

github.com/adobe/helix-pipeline

adobe/helix-pipeline

95 lines (55 loc) • 3.36 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
# Response Schema ```txt https://ns.adobe.com/helix/pipeline/response ``` The HTTP response object | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- | | Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [response.schema.json](response.schema.json "open original schema") | ## Response Type `object` ([Response](response.md)) # Response Properties | Property | Type | Required | Nullable | Defined by | | :-------------------- | ------------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------- | | [status](#status) | `integer` | Optional | cannot be null | [Response](response-properties-status.md "https://ns.adobe.com/helix/pipeline/response#/properties/status") | | [body](#body) | Merged | Optional | cannot be null | [Response](response-properties-body.md "https://ns.adobe.com/helix/pipeline/response#/properties/body") | | [document](#document) | `object` | Optional | cannot be null | [Response](response-properties-document.md "https://ns.adobe.com/helix/pipeline/response#/properties/document") | | [headers](#headers) | Not specified | Optional | cannot be null | [Response](response-properties-headers.md "https://ns.adobe.com/helix/pipeline/response#/properties/headers") | ## status The HTTP status code `status` - is optional - Type: `integer` - cannot be null - defined in: [Response](response-properties-status.md "https://ns.adobe.com/helix/pipeline/response#/properties/status") ### status Type `integer` ## body `body` - is optional - Type: merged type ([Details](response-properties-body.md)) - cannot be null - defined in: [Response](response-properties-body.md "https://ns.adobe.com/helix/pipeline/response#/properties/body") ### body Type merged type ([Details](response-properties-body.md)) any of - [Untitled undefined type in Response](response-properties-body-anyof-0.md "check type definition") - [Untitled object in Response](response-properties-body-anyof-1.md "check type definition") ## document The DOM-compatible representation of the response document `document` - is optional - Type: `object` ([Details](response-properties-document.md)) - cannot be null - defined in: [Response](response-properties-document.md "https://ns.adobe.com/helix/pipeline/response#/properties/document") ### document Type `object` ([Details](response-properties-document.md)) ## headers The HTTP headers of the response `headers` - is optional - Type: unknown - cannot be null - defined in: [Response](response-properties-headers.md "https://ns.adobe.com/helix/pipeline/response#/properties/headers") ### headers Type unknown