| 1 | # Action Schema
|
| 2 |
|
| 3 | ```txt
|
| 4 | https://ns.adobe.com/helix/pipeline/action
|
| 5 | ```
|
| 6 |
|
| 7 | Tracks the OpenWhisk action invocation
|
| 8 |
|
| 9 |
|
| 10 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
| 11 | | :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------- |
|
| 12 | | Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [action.schema.json](action.schema.json "open original schema") |
|
| 13 |
|
| 14 | ## Action Type
|
| 15 |
|
| 16 | `object` ([Action](action.md))
|
| 17 |
|
| 18 | # Action Properties
|
| 19 |
|
| 20 | | Property | Type | Required | Nullable | Defined by |
|
| 21 | | :---------------------------- | -------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------- |
|
| 22 | | [request](#request) | Merged | Optional | cannot be null | [Action](action-properties-raw-request.md "https://ns.adobe.com/helix/pipeline/rawrequest#/properties/request") |
|
| 23 | | [logger](#logger) | `object` | Optional | cannot be null | [Action](action-properties-logger.md "https://ns.adobe.com/helix/pipeline/action#/properties/logger") |
|
| 24 | | [debug](#debug) | `object` | Optional | cannot be null | [Action](action-properties-debug.md "https://ns.adobe.com/helix/pipeline/action#/properties/debug") |
|
| 25 | | [secrets](#secrets) | `object` | Optional | cannot be null | [Action](action-properties-secrets.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/secrets") |
|
| 26 | | [transformer](#transformer) | `object` | Optional | cannot be null | [Action](action-properties-transformer.md "https://ns.adobe.com/helix/pipeline/action#/properties/transformer") |
|
| 27 | | [downloader](#downloader) | `object` | Optional | cannot be null | [Action](action-properties-downloader.md "https://ns.adobe.com/helix/pipeline/action#/properties/downloader") |
|
| 28 | | [markupconfig](#markupconfig) | `object` | Optional | cannot be null | [Action](action-properties-markupconfig.md "https://ns.adobe.com/helix/pipeline/action#/properties/markupconfig") |
|
| 29 |
|
| 30 | ## request
|
| 31 |
|
| 32 | The Request Object used for Invoking OpenWhisk
|
| 33 |
|
| 34 |
|
| 35 | `request`
|
| 36 |
|
| 37 | - is optional
|
| 38 | - Type: `object` ([Raw Request](action-properties-raw-request.md))
|
| 39 | - cannot be null
|
| 40 | - defined in: [Action](action-properties-raw-request.md "https://ns.adobe.com/helix/pipeline/rawrequest#/properties/request")
|
| 41 |
|
| 42 | ### request Type
|
| 43 |
|
| 44 | `object` ([Raw Request](action-properties-raw-request.md))
|
| 45 |
|
| 46 | all of
|
| 47 |
|
| 48 | - [Untitled undefined type in Raw Request](rawrequest-definitions-rawrequest.md "check type definition")
|
| 49 |
|
| 50 | ## logger
|
| 51 |
|
| 52 | A helix-log [SimpleInterface](https://github.com/adobe/helix-log) logger instance.
|
| 53 |
|
| 54 |
|
| 55 | `logger`
|
| 56 |
|
| 57 | - is optional
|
| 58 | - Type: `object` ([Details](action-properties-logger.md))
|
| 59 | - cannot be null
|
| 60 | - defined in: [Action](action-properties-logger.md "https://ns.adobe.com/helix/pipeline/action#/properties/logger")
|
| 61 |
|
| 62 | ### logger Type
|
| 63 |
|
| 64 | `object` ([Details](action-properties-logger.md))
|
| 65 |
|
| 66 | ## debug
|
| 67 |
|
| 68 | Internal information related to debugging.
|
| 69 |
|
| 70 |
|
| 71 | `debug`
|
| 72 |
|
| 73 | - is optional
|
| 74 | - Type: `object` ([Details](action-properties-debug.md))
|
| 75 | - cannot be null
|
| 76 | - defined in: [Action](action-properties-debug.md "https://ns.adobe.com/helix/pipeline/action#/properties/debug")
|
| 77 |
|
| 78 | ### debug Type
|
| 79 |
|
| 80 | `object` ([Details](action-properties-debug.md))
|
| 81 |
|
| 82 | ## secrets
|
| 83 |
|
| 84 | Secrets passed into the pipeline such as API Keys or configuration settings.
|
| 85 |
|
| 86 |
|
| 87 | `secrets`
|
| 88 |
|
| 89 | - is optional
|
| 90 | - Type: `object` ([Secrets](action-properties-secrets.md))
|
| 91 | - cannot be null
|
| 92 | - defined in: [Action](action-properties-secrets.md "https://ns.adobe.com/helix/pipeline/secrets#/properties/secrets")
|
| 93 |
|
| 94 | ### secrets Type
|
| 95 |
|
| 96 | `object` ([Secrets](action-properties-secrets.md))
|
| 97 |
|
| 98 | ## transformer
|
| 99 |
|
| 100 | A VDOMTransformer instance
|
| 101 |
|
| 102 |
|
| 103 | `transformer`
|
| 104 |
|
| 105 | - is optional
|
| 106 | - Type: `object` ([Details](action-properties-transformer.md))
|
| 107 | - cannot be null
|
| 108 | - defined in: [Action](action-properties-transformer.md "https://ns.adobe.com/helix/pipeline/action#/properties/transformer")
|
| 109 |
|
| 110 | ### transformer Type
|
| 111 |
|
| 112 | `object` ([Details](action-properties-transformer.md))
|
| 113 |
|
| 114 | ## downloader
|
| 115 |
|
| 116 | A Downloader instance
|
| 117 |
|
| 118 |
|
| 119 | `downloader`
|
| 120 |
|
| 121 | - is optional
|
| 122 | - Type: `object` ([Details](action-properties-downloader.md))
|
| 123 | - cannot be null
|
| 124 | - defined in: [Action](action-properties-downloader.md "https://ns.adobe.com/helix/pipeline/action#/properties/downloader")
|
| 125 |
|
| 126 | ### downloader Type
|
| 127 |
|
| 128 | `object` ([Details](action-properties-downloader.md))
|
| 129 |
|
| 130 | ## markupconfig
|
| 131 |
|
| 132 | A [markup configuration](https://github.com/adobe/helix-shared/blob/master/docs/markup.md)
|
| 133 |
|
| 134 |
|
| 135 | `markupconfig`
|
| 136 |
|
| 137 | - is optional
|
| 138 | - Type: `object` ([Details](action-properties-markupconfig.md))
|
| 139 | - cannot be null
|
| 140 | - defined in: [Action](action-properties-markupconfig.md "https://ns.adobe.com/helix/pipeline/action#/properties/markupconfig")
|
| 141 |
|
| 142 | ### markupconfig Type
|
| 143 |
|
| 144 | `object` ([Details](action-properties-markupconfig.md))
|