Skip to content

Commit 07c39e6

Browse files
authored
API response documentation formatting, spelling, and clarity (#44)
Modified the response description documentation for spelling and clarity.
1 parent ce57a26 commit 07c39e6

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed
Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
## API Response description
22
API returns (`$api_result`) PHP object:
3-
* allow (0|1) - allow to publish or not, in other words spam or ham
4-
* comment (string) - server comment for requests.
5-
* id (string MD5 HEX hash) - unique request idenifier.
6-
* errno (int) - error number. errno == 0 if requests successfull.
7-
* errstr (string) - comment for error issue, errstr == null if requests successfull.
8-
* account_status - 0 account disabled, 1 account enabled, -1 unknown status.
3+
* allow (`bool/0|1`) – allow result to be published or not, in other words, spam(`0`) or ham(`1`).
4+
* comment (`string`) – server comment for requests.
5+
* id (`MD5 hash hex string`) – unique MD5 hash used as request identifier.
6+
* errno (`int`) - error number or `0` if the request is successful.
7+
* errstr (`string | null`) – comment for error issue or `null` if the request is successful.
8+
* account_status (`int`) – Status of the account:
9+
* `0` account disabled
10+
* `1` account enabled,
11+
* `-1` unknown status.

0 commit comments

Comments
 (0)