Skip to content

Commit

Permalink
docs(stories):shell request description
Browse files Browse the repository at this point in the history
Signed-off-by: Aleksandr_Zavadkin <[email protected]>
  • Loading branch information
gochicus committed Jun 20, 2024
1 parent 4971e5a commit 6ca3520
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion source/includes/_stories.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,30 @@ Section describes how to use Stories

## Request campaign

//
// Request path /story/STORY_ID
// First step of the process is a path check

case '/story':
if( !$code ) {
throw new RequestError('Incorrect id or missing');
}
return StorySingle::run($code, $params, $request, $cancellation);

| Request parameters | required | description |
|____________________|______________|_________________|
| story_id | true | story id |
| shop_id | true | shop id |
| did | true | device id |

```shell
curl -X GET "https://api.example.com/story" \
-H "Content-Type: application/json" \
-d '{
"id": "STORY_ID",
"shop_id": "SHOP_ID",
"did": "DEVICE_ID"
}
```

```kotlin
// Show story by id:
Expand Down

0 comments on commit 6ca3520

Please sign in to comment.