Skip to content

API response documentation formatting, spelling, and clarity #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

API response documentation formatting, spelling, and clarity #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions examples/api_response_description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
## API Response description
API returns (`$api_result`) PHP object:
* allow (0|1) - allow to publish or not, in other words spam or ham
* comment (string) - server comment for requests.
* id (string MD5 HEX hash) - unique request idenifier.
* errno (int) - error number. errno == 0 if requests successfull.
* errstr (string) - comment for error issue, errstr == null if requests successfull.
* account_status - 0 account disabled, 1 account enabled, -1 unknown status.
* allow (`bool/0|1`) – allow result to be published or not, in other words, spam(`0`) or ham(`1`).
* comment (`string`) – server comment for requests.
* id (`MD5 hash hex string`) – unique MD5 hash used as request identifier.
* errno (`int`) - error number or `0` if the request is successful.
* errstr (`string | null`) – comment for error issue or `null` if the request is successful.
* account_status (`int`) – Status of the account:
* `0` account disabled
* `1` account enabled,
* `-1` unknown status.