| 1 | {"meta:license":["Copyright 2018 Adobe. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the \"License\");","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0","","Unless required by applicable law or agreed to in writing, software distributed under","the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS","OF ANY KIND, either express or implied. See the License for the specific language","governing permissions and limitations under the License."],"$id":"https://ns.adobe.com/helix/pipeline/request","$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"Request","meta:status":"stabilizing","description":"The HTTP Request","additionalProperties":false,"properties":{"url":{"type":"string","description":"The path and request parameters of the client request URL.","examples":["/docs/api/general/index.nav.html?a=1"]},"path":{"type":"string","description":"The path of the client request URL","examples":["/docs/api/general/index.nav.html"]},"pathInfo":{"type":"string","description":"The part of the client path that is relative to the rootPath.","examples":["/general/index.nav.html"]},"rootPath":{"type":"string","description":"The request root path of the current strain.","examples":["/docs/api"]},"selector":{"type":"string","description":"The selector (sub-type indicator).","examples":["","nav"]},"extension":{"type":"string","description":"The extension of the requested resource.","examples":["html","json"]},"method":{"type":"string","description":"The HTTP method of the request. Note: method names can be lower-case.","meta:enum":{"GET":"GET request","POST":"POST request","PUT":"PUT request (not handled by Helix)","DELETE":"DELETE request (not handled by Helix)"}},"headers":{"description":"The HTTP headers of the request. Note: all header names will be lower-case.","additionalProperties":{"type":"string"}},"params":{"type":"object","description":"The passed through (and filtered) URL parameters of the request.","additionalProperties":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"queryString":{"type":"string","description":"The original query string.","examples":["?parameter1=foo¶meter2=bar"]}}}
|