1 | # Request Schema
|
2 |
|
3 | ```txt
|
4 | https://ns.adobe.com/helix/pipeline/request
|
5 | ```
|
6 |
|
7 | The HTTP Request
|
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 | [request.schema.json](request.schema.json "open original schema") |
|
13 |
|
14 | ## Request Type
|
15 |
|
16 | `object` ([Request](request.md))
|
17 |
|
18 | # Request Properties
|
19 |
|
20 | | Property | Type | Required | Nullable | Defined by |
|
21 | | :-------------------------- | ------------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------------- |
|
22 | | [url](#url) | `string` | Optional | cannot be null | [Request](request-properties-url.md "https://ns.adobe.com/helix/pipeline/request#/properties/url") |
|
23 | | [path](#path) | `string` | Optional | cannot be null | [Request](request-properties-path.md "https://ns.adobe.com/helix/pipeline/request#/properties/path") |
|
24 | | [pathInfo](#pathInfo) | `string` | Optional | cannot be null | [Request](request-properties-pathinfo.md "https://ns.adobe.com/helix/pipeline/request#/properties/pathInfo") |
|
25 | | [rootPath](#rootPath) | `string` | Optional | cannot be null | [Request](request-properties-rootpath.md "https://ns.adobe.com/helix/pipeline/request#/properties/rootPath") |
|
26 | | [selector](#selector) | `string` | Optional | cannot be null | [Request](request-properties-selector.md "https://ns.adobe.com/helix/pipeline/request#/properties/selector") |
|
27 | | [extension](#extension) | `string` | Optional | cannot be null | [Request](request-properties-extension.md "https://ns.adobe.com/helix/pipeline/request#/properties/extension") |
|
28 | | [method](#method) | `string` | Optional | cannot be null | [Request](request-properties-method.md "https://ns.adobe.com/helix/pipeline/request#/properties/method") |
|
29 | | [headers](#headers) | Not specified | Optional | cannot be null | [Request](request-properties-headers.md "https://ns.adobe.com/helix/pipeline/request#/properties/headers") |
|
30 | | [params](#params) | `object` | Optional | cannot be null | [Request](request-properties-params.md "https://ns.adobe.com/helix/pipeline/request#/properties/params") |
|
31 | | [queryString](#queryString) | `string` | Optional | cannot be null | [Request](request-properties-querystring.md "https://ns.adobe.com/helix/pipeline/request#/properties/queryString") |
|
32 |
|
33 | ## url
|
34 |
|
35 | The path and request parameters of the client request URL.
|
36 |
|
37 |
|
38 | `url`
|
39 |
|
40 | - is optional
|
41 | - Type: `string`
|
42 | - cannot be null
|
43 | - defined in: [Request](request-properties-url.md "https://ns.adobe.com/helix/pipeline/request#/properties/url")
|
44 |
|
45 | ### url Type
|
46 |
|
47 | `string`
|
48 |
|
49 | ### url Examples
|
50 |
|
51 | ```json
|
52 | "/docs/api/general/index.nav.html?a=1"
|
53 | ```
|
54 |
|
55 | ## path
|
56 |
|
57 | The path of the client request URL
|
58 |
|
59 |
|
60 | `path`
|
61 |
|
62 | - is optional
|
63 | - Type: `string`
|
64 | - cannot be null
|
65 | - defined in: [Request](request-properties-path.md "https://ns.adobe.com/helix/pipeline/request#/properties/path")
|
66 |
|
67 | ### path Type
|
68 |
|
69 | `string`
|
70 |
|
71 | ### path Examples
|
72 |
|
73 | ```json
|
74 | "/docs/api/general/index.nav.html"
|
75 | ```
|
76 |
|
77 | ## pathInfo
|
78 |
|
79 | The part of the client path that is relative to the rootPath.
|
80 |
|
81 |
|
82 | `pathInfo`
|
83 |
|
84 | - is optional
|
85 | - Type: `string`
|
86 | - cannot be null
|
87 | - defined in: [Request](request-properties-pathinfo.md "https://ns.adobe.com/helix/pipeline/request#/properties/pathInfo")
|
88 |
|
89 | ### pathInfo Type
|
90 |
|
91 | `string`
|
92 |
|
93 | ### pathInfo Examples
|
94 |
|
95 | ```json
|
96 | "/general/index.nav.html"
|
97 | ```
|
98 |
|
99 | ## rootPath
|
100 |
|
101 | The request root path of the current strain.
|
102 |
|
103 |
|
104 | `rootPath`
|
105 |
|
106 | - is optional
|
107 | - Type: `string`
|
108 | - cannot be null
|
109 | - defined in: [Request](request-properties-rootpath.md "https://ns.adobe.com/helix/pipeline/request#/properties/rootPath")
|
110 |
|
111 | ### rootPath Type
|
112 |
|
113 | `string`
|
114 |
|
115 | ### rootPath Examples
|
116 |
|
117 | ```json
|
118 | "/docs/api"
|
119 | ```
|
120 |
|
121 | ## selector
|
122 |
|
123 | The selector (sub-type indicator).
|
124 |
|
125 |
|
126 | `selector`
|
127 |
|
128 | - is optional
|
129 | - Type: `string`
|
130 | - cannot be null
|
131 | - defined in: [Request](request-properties-selector.md "https://ns.adobe.com/helix/pipeline/request#/properties/selector")
|
132 |
|
133 | ### selector Type
|
134 |
|
135 | `string`
|
136 |
|
137 | ### selector Examples
|
138 |
|
139 | ```json
|
140 | ""
|
141 | ```
|
142 |
|
143 | ```json
|
144 | "nav"
|
145 | ```
|
146 |
|
147 | ## extension
|
148 |
|
149 | The extension of the requested resource.
|
150 |
|
151 |
|
152 | `extension`
|
153 |
|
154 | - is optional
|
155 | - Type: `string`
|
156 | - cannot be null
|
157 | - defined in: [Request](request-properties-extension.md "https://ns.adobe.com/helix/pipeline/request#/properties/extension")
|
158 |
|
159 | ### extension Type
|
160 |
|
161 | `string`
|
162 |
|
163 | ### extension Examples
|
164 |
|
165 | ```json
|
166 | "html"
|
167 | ```
|
168 |
|
169 | ```json
|
170 | "json"
|
171 | ```
|
172 |
|
173 | ## method
|
174 |
|
175 | The HTTP method of the request. Note: method names can be lower-case.
|
176 |
|
177 |
|
178 | `method`
|
179 |
|
180 | - is optional
|
181 | - Type: `string`
|
182 | - cannot be null
|
183 | - defined in: [Request](request-properties-method.md "https://ns.adobe.com/helix/pipeline/request#/properties/method")
|
184 |
|
185 | ### method Type
|
186 |
|
187 | `string`
|
188 |
|
189 | ## headers
|
190 |
|
191 | The HTTP headers of the request. Note: all header names will be lower-case.
|
192 |
|
193 |
|
194 | `headers`
|
195 |
|
196 | - is optional
|
197 | - Type: unknown
|
198 | - cannot be null
|
199 | - defined in: [Request](request-properties-headers.md "https://ns.adobe.com/helix/pipeline/request#/properties/headers")
|
200 |
|
201 | ### headers Type
|
202 |
|
203 | unknown
|
204 |
|
205 | ## params
|
206 |
|
207 | The passed through (and filtered) URL parameters of the request.
|
208 |
|
209 |
|
210 | `params`
|
211 |
|
212 | - is optional
|
213 | - Type: `object` ([Details](request-properties-params.md))
|
214 | - cannot be null
|
215 | - defined in: [Request](request-properties-params.md "https://ns.adobe.com/helix/pipeline/request#/properties/params")
|
216 |
|
217 | ### params Type
|
218 |
|
219 | `object` ([Details](request-properties-params.md))
|
220 |
|
221 | ## queryString
|
222 |
|
223 | The original query string.
|
224 |
|
225 |
|
226 | `queryString`
|
227 |
|
228 | - is optional
|
229 | - Type: `string`
|
230 | - cannot be null
|
231 | - defined in: [Request](request-properties-querystring.md "https://ns.adobe.com/helix/pipeline/request#/properties/queryString")
|
232 |
|
233 | ### queryString Type
|
234 |
|
235 | `string`
|
236 |
|
237 | ### queryString Examples
|
238 |
|
239 | ```json
|
240 | "?parameter1=foo¶meter2=bar"
|
241 | ```
|