UNPKG

@adobe/helix-pipeline

Version:

This project provides helper functions and default implementations for creating Hypermedia Processing Pipelines.

github.com/adobe/helix-pipeline

adobe/helix-pipeline

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