Skip to content

Commit

Permalink
Documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
bczoma committed Mar 22, 2024
1 parent da1b185 commit 336dad4
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion examples/adding-headers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The module default for the `enabled` variable is true, which enables both the RD

### Output

The module `rdp` output refers to the created REST delivery point.
The module `rdp`, `consumer` and `queue_binding` outputs refer to the created REST delivery point, REST consumer and queue binding.

## Created resources

Expand Down
2 changes: 1 addition & 1 deletion examples/basic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The module default for the `enabled` variable is true, which enables both the RD

### Output

The module `rdp` output refers to the created REST delivery point.
The module `rdp`, `consumer` and `queue_binding` outputs refer to the created REST delivery point, REST consumer and queue binding.

## Created resources

Expand Down
5 changes: 3 additions & 2 deletions examples/using-substitution-expressions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Strings containing substitution expressions must be [properly escaped](https://d

* `msg_vpn_name` - set to `default` in the example
* `rest_delivery_point_name`
* `url` - set to `http://example.com/$${msgId()}` in the example. Notice the escape sequence, which results in `${msgId()` configured on the broker. Substitution expressions are only suported in the path component.
* `url` - set to `http://example.com/$${msgId()}` in the example. Notice the escape sequence, which results in `${msgId()}` configured on the broker. Substitution expressions are only suported in the path component.
* `queue_name` - `rdp_queue`, the queue that has been created to be used with the RDP

Important: The REST delivery point must have permission to consume messages from the queue — to achieve this, the queue’s owner must be set to `#rdp/<rest_delivery_point_name>` or the queue’s permissions for non-owner clients must be set to at least `consume` level access. Queue ingress and egress must also be enabled.
Expand All @@ -33,7 +33,7 @@ The module default for the `enabled` variable is true, which enables both the RD

### Output

The module `rdp` output refers to the created REST delivery point.
The module `rdp`, `consumer` and `queue_binding` outputs refer to the created REST delivery point, REST consumer and queue binding.

## Created resources

Expand All @@ -44,6 +44,7 @@ This example will create following resources:
* `solacebroker_msg_vpn_rest_delivery_point`
* `solacebroker_msg_vpn_rest_delivery_point_rest_consumer`
* `solacebroker_msg_vpn_rest_delivery_point_queue_binding`
* `solacebroker_msg_vpn_rest_delivery_point_queue_binding_request_header`

## Running the Example

Expand Down

0 comments on commit 336dad4

Please sign in to comment.