Skip to content

Commit 3bc99c3

Browse files
weltekialexellis
authored andcommitted
Remove function name from async cancel examples
The endpoint was updated to only take the call id as a path parameter. Signed-off-by: Han Verstraete (OpenFaaS Ltd) <[email protected]>
1 parent 681e45c commit 3bc99c3

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/reference/async.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,12 @@ Alternatively you can specify another asynchronous or synchronous function to ru
7373

7474
### Cancel async invocations
7575

76-
Sometimes you might need to cancel an ongoing or queued invocation. Asynchronous invocations can be cancelled by making an HTTP `DELETE` request to `/async-function/<name>/<call-id>`. The call id is the X-Call-Id header that was returned when submitting the async invocation.
76+
Sometimes you might need to cancel an ongoing or queued invocation. Asynchronous invocations can be cancelled by making an HTTP `DELETE` request to `/async-function/<call-id>`. The call id is the X-Call-Id header that was returned when submitting the async invocation.
7777

7878
```bash
7979
$ curl -i \
8080
-X DELETE \
81-
http://127.0.0.1:8080/async-function/sleep/ee7fcaeb-82b7-4834-b677-45005c5f0b1b
81+
http://127.0.0.1:8080/async-function/ee7fcaeb-82b7-4834-b677-45005c5f0b1b
8282
```
8383

8484
A `202 Accepted` message will be issued if the request is successful.

docs/reference/rest-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,12 +134,12 @@ You can expose Functions with a REST-like mapping or on custom subdomains with t
134134

135135
### Cancel an async invocation
136136

137-
To cancel an asynchronous function invocation an HTTP `DELETE` request can be made to the async function endpoint with the call id of the invocation that needs to be cancelled as a path parameter: `/async-function/<name>.<namespace>/<call-id>`
137+
To cancel an asynchronous function invocation an HTTP `DELETE` request can be made to the async function endpoint with the call id of the invocation that needs to be cancelled as a path parameter: `/async-function/<call-id>`
138138

139139
```bash
140140
curl -i \
141141
-X DELETE \
142-
http://127.0.0.1:8080/async-function/sleep/ee7fcaeb-82b7-4834-b677-45005c5f0b1b
142+
http://127.0.0.1:8080/async-function/ee7fcaeb-82b7-4834-b677-45005c5f0b1b
143143
```
144144

145145
A `202 Accepted` message will be issued if the request is successful.

0 commit comments

Comments
 (0)