| 1 | # Untitled object in Raw Request Schema
|
| 2 |
|
| 3 | ```txt
|
| 4 | https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params
|
| 5 | ```
|
| 6 |
|
| 7 | 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.
|
| 8 |
|
| 9 |
|
| 10 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
| 11 | | :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------- |
|
| 12 | | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [rawrequest.schema.json\*](rawrequest.schema.json "open original schema") |
|
| 13 |
|
| 14 | ## params Type
|
| 15 |
|
| 16 | `object` ([Details](rawrequest-definitions-rawrequest-properties-params.md))
|
| 17 |
|
| 18 | # undefined Properties
|
| 19 |
|
| 20 | | Property | Type | Required | Nullable | Defined by |
|
| 21 | | :------------------------------ | -------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| 22 | | [owner](#owner) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-owner.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/owner") |
|
| 23 | | [repo](#repo) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-repo.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/repo") |
|
| 24 | | [ref](#ref) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-ref.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/ref") |
|
| 25 | | [branch](#branch) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-branch.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/branch") |
|
| 26 | | [path](#path) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-path.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/path") |
|
| 27 | | [rootPath](#rootPath) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-rootpath.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/rootPath") |
|
| 28 | | [strain](#strain) | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-strain.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/strain") |
|
| 29 | | [\_\_ow_headers](#__ow_headers) | `object` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/\_\_ow_headers") |
|
| 30 | | Additional Properties | `string` | Optional | cannot be null | [Raw Request](rawrequest-definitions-rawrequest-properties-params-additionalproperties.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/additionalProperties") |
|
| 31 |
|
| 32 | ## owner
|
| 33 |
|
| 34 | Owner of the GitHub repository. This is the name of a user or organization.
|
| 35 |
|
| 36 |
|
| 37 | `owner`
|
| 38 |
|
| 39 | - is optional
|
| 40 | - Type: `string`
|
| 41 | - cannot be null
|
| 42 | - defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-owner.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/owner")
|
| 43 |
|
| 44 | ### owner Type
|
| 45 |
|
| 46 | `string`
|
| 47 |
|
| 48 | ## repo
|
| 49 |
|
| 50 | Repository where content originates
|
| 51 |
|
| 52 |
|
| 53 | `repo`
|
| 54 |
|
| 55 | - is optional
|
| 56 | - Type: `string`
|
| 57 | - cannot be null
|
| 58 | - defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-repo.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/repo")
|
| 59 |
|
| 60 | ### repo Type
|
| 61 |
|
| 62 | `string`
|
| 63 |
|
| 64 | ## ref
|
| 65 |
|
| 66 | Name of the branch or tag or the SHA of the commit
|
| 67 |
|
| 68 |
|
| 69 | `ref`
|
| 70 |
|
| 71 | - is optional
|
| 72 | - Type: `string`
|
| 73 | - cannot be null
|
| 74 | - defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-ref.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/ref")
|
| 75 |
|
| 76 | ### ref Type
|
| 77 |
|
| 78 | `string`
|
| 79 |
|
| 80 | ## branch
|
| 81 |
|
| 82 | Name of the branch or tag. defaults back to the value of 'ref' if missing.
|
| 83 |
|
| 84 |
|
| 85 | `branch`
|
| 86 |
|
| 87 | - is optional
|
| 88 | - Type: `string`
|
| 89 | - cannot be null
|
| 90 | - defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-branch.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/branch")
|
| 91 |
|
| 92 | ### branch Type
|
| 93 |
|
| 94 | `string`
|
| 95 |
|
| 96 | ## path
|
| 97 |
|
| 98 | Path to the requested (Markdown) file
|
| 99 |
|
| 100 |
|
| 101 | `path`
|
| 102 |
|
| 103 | - is optional
|
| 104 | - Type: `string`
|
| 105 | - cannot be null
|
| 106 | - defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-path.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/path")
|
| 107 |
|
| 108 | ### path Type
|
| 109 |
|
| 110 | `string`
|
| 111 |
|
| 112 | ### path Examples
|
| 113 |
|
| 114 | ```json
|
| 115 | "/general/index.md"
|
| 116 | ```
|
| 117 |
|
| 118 | ## rootPath
|
| 119 |
|
| 120 | The request root path of the current strain.
|
| 121 |
|
| 122 |
|
| 123 | `rootPath`
|
| 124 |
|
| 125 | - is optional
|
| 126 | - Type: `string`
|
| 127 | - cannot be null
|
| 128 | - defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-rootpath.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/rootPath")
|
| 129 |
|
| 130 | ### rootPath Type
|
| 131 |
|
| 132 | `string`
|
| 133 |
|
| 134 | ### rootPath Examples
|
| 135 |
|
| 136 | ```json
|
| 137 | "/docs/api"
|
| 138 | ```
|
| 139 |
|
| 140 | ## strain
|
| 141 |
|
| 142 | The resolved strain (variant)
|
| 143 |
|
| 144 |
|
| 145 | `strain`
|
| 146 |
|
| 147 | - is optional
|
| 148 | - Type: `string`
|
| 149 | - cannot be null
|
| 150 | - defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-strain.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/strain")
|
| 151 |
|
| 152 | ### strain Type
|
| 153 |
|
| 154 | `string`
|
| 155 |
|
| 156 | ## \_\_ow_headers
|
| 157 |
|
| 158 | Deprecated: The original OpenWhisk request headers
|
| 159 |
|
| 160 |
|
| 161 | `__ow_headers`
|
| 162 |
|
| 163 | - is optional
|
| 164 | - Type: `object` ([Details](rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md))
|
| 165 | - cannot be null
|
| 166 | - defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/properties/\_\_ow_headers")
|
| 167 |
|
| 168 | ### \_\_ow_headers Type
|
| 169 |
|
| 170 | `object` ([Details](rawrequest-definitions-rawrequest-properties-params-properties-__ow_headers.md))
|
| 171 |
|
| 172 | ## Additional Properties
|
| 173 |
|
| 174 | Additional properties are allowed, as long as they follow this schema:
|
| 175 |
|
| 176 | All other parameters are interpreted as string.
|
| 177 |
|
| 178 |
|
| 179 | - is optional
|
| 180 | - Type: `string`
|
| 181 | - cannot be null
|
| 182 | - defined in: [Raw Request](rawrequest-definitions-rawrequest-properties-params-additionalproperties.md "https://ns.adobe.com/helix/pipeline/rawrequest#/definitions/rawrequest/properties/params/additionalProperties")
|
| 183 |
|
| 184 | ### additionalProperties Type
|
| 185 |
|
| 186 | `string`
|