| 1 | # Raw Request Schema
|
| 2 |
|
| 3 | ```txt
|
| 4 | https://ns.adobe.com/helix/pipeline/rawrequest#/properties/request
|
| 5 | ```
|
| 6 |
|
| 7 | The Request Object used for Invoking OpenWhisk
|
| 8 |
|
| 9 |
|
| 10 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
| 11 | | :--------------------- | ---------- | ------------ | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- |
|
| 12 | | Cannot be instantiated | Yes | Experimental | Unknown identifiability | Forbidden | Allowed | none | [action.schema.json\*](action.schema.json "open original schema") |
|
| 13 |
|
| 14 | ## request Type
|
| 15 |
|
| 16 | `object` ([Raw Request](action-properties-raw-request.md))
|
| 17 |
|
| 18 | all of
|
| 19 |
|
| 20 | - [Untitled undefined type in Raw Request](rawrequest-definitions-rawrequest.md "check type definition")
|
| 21 |
|
| 22 | # Raw Request Definitions
|
| 23 |
|
| 24 | ## Definitions group rawrequest
|
| 25 |
|
| 26 | Reference this group by using
|
| 27 |
|
| 28 | ```json
|
| 29 | {"$ref":"https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest"}
|
| 30 | ```
|
| 31 |
|
| 32 | | Property | Type | Required | Nullable | Defined by |
|
| 33 | | :------------------ | -------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| 34 | | [headers](#headers) | `object` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-headers.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers") |
|
| 35 | | [method](#method) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-method.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/method") |
|
| 36 | | [params](#params) | `object` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params") |
|
| 37 |
|
| 38 | ### headers
|
| 39 |
|
| 40 | The headers of the request made to OpenWhisk (or Simulator)
|
| 41 |
|
| 42 |
|
| 43 | `headers`
|
| 44 |
|
| 45 | - is optional
|
| 46 | - Type: `object` ([Details](rawrequest-definitions-rawrequest-properties-headers.md))
|
| 47 | - cannot be null
|
| 48 | - defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-headers.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/headers")
|
| 49 |
|
| 50 | #### headers Type
|
| 51 |
|
| 52 | `object` ([Details](rawrequest-definitions-rawrequest-properties-headers.md))
|
| 53 |
|
| 54 | ### method
|
| 55 |
|
| 56 | The HTTP method of the request made to OpenWhisk (or Simulator). Note: OpenWhisk converts all methods to lowercase.
|
| 57 |
|
| 58 |
|
| 59 | `method`
|
| 60 |
|
| 61 | - is optional
|
| 62 | - Type: `string`
|
| 63 | - cannot be null
|
| 64 | - defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-method.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/method")
|
| 65 |
|
| 66 | #### method Type
|
| 67 |
|
| 68 | `string`
|
| 69 |
|
| 70 | ### params
|
| 71 |
|
| 72 | Parameters used to invoke the OpenWhisk action. These are either URL parameters added when invoking the action from the CDN or default parameters set during creation of the action.
|
| 73 |
|
| 74 |
|
| 75 | `params`
|
| 76 |
|
| 77 | - is optional
|
| 78 | - Type: `object` ([Details](rawrequest-definitions-rawrequest-properties-params.md))
|
| 79 | - cannot be null
|
| 80 | - defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params")
|
| 81 |
|
| 82 | #### params Type
|
| 83 |
|
| 84 | `object` ([Details](rawrequest-definitions-rawrequest-properties-params.md))
|