Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove mutual exclusivity constraint between payload and pointers. Rename to replacements #183

Merged
merged 2 commits into from
May 8, 2024
Merged

Remove mutual exclusivity constraint between payload and pointers. Rename to replacements #183

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8c66a4
Remove mutual exclusivity constraint between `payload` and `pointers`…
frankkilcommins Apr 25, 2024
cf6e8d7
chore: update payload description
frankkilcommins Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions versions/1.0.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,9 @@ The Workflows Specification can articulate these workflows in a human-readable a
- [Request Body Object](#request-body-object)
- [Fixed Fields](#fixed-fields-12)
- [Request Body Object Example](#requestbody-object-example)
- [Payload Pointer Object](#payload-pointer-object)
- [Payload Replacement Object](#payload-replacement-object)
- [Fixed Fields](#fixed-fields-13)
- [Payload Pointer Object Example](#payload-pointer-object-example)
- [Payload Replacement Object Example](#payload-replacement-object-example)
- [Runtime Expressions](#runtime-expressions)
- [Specification Extensions](#specification-extensions)
- [Security Considerations](#security-considerations)
Expand Down Expand Up @@ -769,8 +769,8 @@ A single request body describing the `Content-Type` and request body content to
Field Name | Type | Description
---|:---:|---
<a name="requestBodyContentType"></a>contentType | `string` | The Content-Type for the request content. If omitted then refer to Content-Type specified at the targeted operation to understand serialization requirements.
<a name="requestBodyPayload"></a>payload | Any | A value representing the request body payload. The value can be a literal value or can contain [Runtime Expressions](#runtime-expressions) which MUST be evaluated prior to calling the referenced operation. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. This field is mutually exclusive to `pointers`.
<a name="requestBodyPointers"></a>pointers | [[Payload Pointer Object](#payload-pointer-object)] | A list of locations and values to set within a payload. This field is mutually exclusive to `payload`.
<a name="requestBodyPayload"></a>payload | Any | A value representing the request body payload. The value can be a literal value or can contain [Runtime Expressions](#runtime-expressions) which MUST be evaluated prior to calling the referenced operation. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.
frankkilcommins marked this conversation as resolved.
Show resolved Hide resolved
frankkilcommins marked this conversation as resolved.
Show resolved Hide resolved
<a name="requestBodyReplacements"></a>replacements | [[Payload Replacement Object](#payload-replacement-object)] | A list of locations and values to set within a payload.

This object MAY be extended with [Specification Extensions](#specificationExtensions).

Expand Down Expand Up @@ -839,18 +839,18 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
payload: "client_id={$inputs.clientId}&grant_type={$inputs.grantType}&redirect_uri={$inputs.redirectUri}&client_secret={$inputs.clientSecret}&code{$steps.browser-authorize.outputs.code}&scope=$inputs.scope}"
```

#### Payload Pointer Object
Described a target location within a payload (e.g., a request body) and a value to set within the target location.
#### Payload Replacement Object
Describes a location within a payload (e.g., a request body) and a value to set within the location.

##### Fixed Fields
Field Name | Type | Description
---|:---:|---
<a name="payloadPointerTarget"></a>target | `string` | **REQUIRED**. A [JSON Pointer](https://tools.ietf.org/html/rfc6901) or [XPath Expression](https://www.w3.org/TR/xpath-31/#id-expressions) which MUST be resolved against the request body. Used to identify the location to inject the `value`.
<a name="payloadPointerValue"></a> value | Any \| {expression} | **REQUIRED**. The value set within the target location. The value can be a constant or a [Runtime Expression](#runtime-expressions) to be evaluated and passed to the referenced operation or workflow.
<a name="payloadReplacementTarget"></a>target | `string` | **REQUIRED**. A [JSON Pointer](https://tools.ietf.org/html/rfc6901) or [XPath Expression](https://www.w3.org/TR/xpath-31/#id-expressions) which MUST be resolved against the request body. Used to identify the location to inject the `value`.
<a name="payloadReplacementValue"></a> value | Any \| {expression} | **REQUIRED**. The value set within the target location. The value can be a constant or a [Runtime Expression](#runtime-expressions) to be evaluated and passed to the referenced operation or workflow.

This object MAY be extended with [Specification Extensions](#specificationExtensions).

##### Payload Pointer Object Example
##### Payload Replacement Object Example

**Runtime Expression Example**
```yaml
Expand Down
Loading