Skip to content

Commit 18fa18f

Browse files
authored
Update README.template.md
1 parent 6e95497 commit 18fa18f

File tree

1 file changed

+7
-23
lines changed

1 file changed

+7
-23
lines changed

.github/templates/README.template.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -123,29 +123,13 @@ curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer API_T
123123

124124
If you are not comfortable / don't want to hardcode your Number for example and/or Recipients in you, may use **Placeholders** in your Request.
125125

126-
You can use [**Variable**](#variables) (`{{.NUMBER}}`) Placeholders and **Body** Placeholders (`{{@data.key}}`)
127-
These Placeholders can be used in the Request Query or the Body of a Request like so:
126+
You can use [**Variable**](#variables) `{{.NUMBER}}` Placeholders and **Body** Placeholders `{{@data.key}}`.
128127

129-
**Body**
130-
131-
```json
132-
{
133-
"number": "{{ .NUMBER }}",
134-
"recipients": "{{ .RECIPIENTS }}"
135-
}
136-
```
137-
138-
**Query**
139-
140-
```
141-
http://sec-signal-api:8880/v1/receive/?@number={{.NUMBER}}
142-
```
143-
144-
**Path**
145-
146-
```
147-
http://sec-signal-api:8880/v1/receive/{{.NUMBER}}
148-
```
128+
| Type | Example |
129+
| :--- | :------ |
130+
| Body | `{"number": "{{ .NUMBER }}", "recipients": "{{ .RECIPIENTS }}"}` |
131+
| Query| `http://sec-signal-api:8880/v1/receive/?@number={{.NUMBER}}` |
132+
| Path | `http://sec-signal-api:8880/v1/receive/{{.NUMBER}}` |
149133

150134
You can also combine them:
151135

@@ -164,7 +148,7 @@ In some cases you may not be able to access / modify the Request Body, in that c
164148
In order to differentiate Injection Queries and _regular_ Queries
165149
you have to add `@` in front of any KeyValue Pair assignment.
166150

167-
Supported types include **strings**, **ints** and **arrays**. See [Formatting](#string-to-type).
151+
Supported types include **strings**, **ints**, **arrays** and **json dictionaries**. See [Formatting](#string-to-type).
168152

169153
## Best Practices
170154

0 commit comments

Comments
 (0)