Skip to content

Commit fcf41c5

Browse files
committed
Updated docs
1 parent 76832c2 commit fcf41c5

4 files changed

Lines changed: 9 additions & 0 deletions

File tree

‎docs/api.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ The `api` product enables users to interact with the [Twitch API](https://dev.tw
1313

1414
The format is `api <method> <url> <flags>`.
1515

16+
All commands will exit with code 0 when the command is successful and the HTTP response is 2xx.
17+
Commands will return a non-zero exit code when the command failed, or when the HTTP response is not 2xx (e.g. 400).
18+
1619
## Arguments
1720

1821
All API commands accept one of two formats:

‎docs/configure.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ This should be the first step if the intent is to use either of those functional
66

77
If you'd prefer to not use the interactive shell, you can pass the settings via the below flags.
88

9+
All commands exit the program with a non-zero exit code when the command fails.
10+
911
**Args**
1012

1113
None.

‎docs/event.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
The `event` product contains commands to trigger mock events for local webhook testing or migration.
1313

14+
All commands exit the program with a non-zero exit code when the command fails, including when an event does not exist, or when the mock EventSub WebSocket server does not start correctly.
15+
1416
## Trigger
1517

1618
Used to either create or send mock events for use with local webhooks testing.

‎docs/mock-api.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ The second is the actual server used to mock the endpoints. In the next iteratio
2424

2525
As of the 1.1 release, this product is in an **open beta** and any bugs should be filed via GitHub Issues. Given the breadth of the tool, it is likely you may run across oddities; please fill out an issue if that is the case.
2626

27+
All commands exit the program with a non-zero exit code when the command fails, including when the mock API server fails to start.
28+
2729
## generate
2830

2931
This command will generate a specified number of users with associated relationships (e.g. subscriptions/mods/blocks).

0 commit comments

Comments
 (0)