Skip to content

Latest commit

 

History

History
98 lines (62 loc) · 2.02 KB

response.schema.md

File metadata and controls

98 lines (62 loc) · 2.02 KB
Raw

Response Schema

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

The HTTP response object

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

Response Properties

Property Type Required Nullable Defined by
body complex Optional No Response (this schema)
document object Optional No Response (this schema)
headers complex Optional No Response (this schema)
status integer Optional No Response (this schema)

body

body

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

body Type

Any following options needs to be fulfilled.

Option 1

Option 2

object with following properties:

Property Type Required

document

The DOM-compatible representation of the response document

document

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

document Type

object with following properties:

Property Type Required

headers

The HTTP headers of the response

headers

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

headers Type

Unknown type ``.

{
  "description": "The HTTP headers of the response",
  "additionalProperties": {
    "type": "string"
  },
  "simpletype": "complex"
}

status

The HTTP status code

status

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

status Type

integer