Skip to content

Latest commit

 

History

History
239 lines (153 loc) · 4.21 KB

request.schema.md

File metadata and controls

239 lines (153 loc) · 4.21 KB
Raw

Request Schema

https://ns.adobe.com/helix/pipeline/request

The HTTP Request

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated No Stabilizing No Forbidden Forbidden request.schema.json

Request Properties

Property Type Required Nullable Defined by
extension string Optional No Request (this schema)
headers complex Optional No Request (this schema)
method string Optional No Request (this schema)
params object Optional No Request (this schema)
path string Optional No Request (this schema)
pathInfo string Optional No Request (this schema)
queryString string Optional No Request (this schema)
rootPath string Optional No Request (this schema)
selector string Optional No Request (this schema)
url string Optional No Request (this schema)

extension

The extension of the requested resource

extension

  • is optional
  • type: string
  • defined in this schema

extension Type

string

extension Examples

"html"
"json"

headers

The HTTP headers of the request. Note: all header names will be lower-case.

headers

  • is optional
  • type: complex
  • defined in this schema

headers Type

Unknown type ``.

{
  "description": "The HTTP headers of the request. Note: all header names will be lower-case.",
  "additionalProperties": {
    "type": "string"
  },
  "simpletype": "complex"
}

method

The HTTP method of the request. Note: method names can be lower-case.

method

  • is optional
  • type: string
  • defined in this schema

method Type

string

method Known Values

Value Description
GET GET request
POST POST request
PUT PUT request (not handled by Helix)
DELETE DELETE request (not handled by Helix)

params

The passed through (and filtered) URL parameters of the request

params

  • is optional
  • type: object
  • defined in this schema

params Type

object with following properties:

Property Type Required

path

The path of the client request URL

path

  • is optional
  • type: string
  • defined in this schema

path Type

string

path Example

"/docs/api/general/index.nav.html"

pathInfo

The part of the client path that is relative to the rootPath

pathInfo

  • is optional
  • type: string
  • defined in this schema

pathInfo Type

string

pathInfo Example

"/general/index.nav.html"

queryString

The original query string

queryString

  • is optional
  • type: string
  • defined in this schema

queryString Type

string

queryString Example

"?parameter1=foo&parameter2=bar"

rootPath

The request root path of the current strain.

rootPath

  • is optional
  • type: string
  • defined in this schema

rootPath Type

string

rootPath Example

"/docs/api"

selector

The selector (sub-type indicator)

selector

  • is optional
  • type: string
  • defined in this schema

selector Type

string

selector Examples

""
"nav"

url

The path and request parameters of the client request URL

url

  • is optional
  • type: string
  • defined in this schema

url Type

string

url Example

"/docs/api/general/index.nav.html?a=1"