doc: audit pass — fix env= bug, params, pagination, missing wrappers, broken examples

- env= -> environment= across all docs (Pydantic silently ignores env=)
- Remove __version__ check (doesn't exist in module)
- Fix APIClient(debug=True) missing required client_id/secret
- Fix post.listremoved usage (takes no postId, just lists removed posts)
- Fix JS true/false -> Python True/False in code blocks
- Fix parameter names: branchName->branch_slug, username->user_slug, postId->post_id
- Add missing lastEvaluatedKey param docs for list jobs
- Note post.listpublic as unauthenticated endpoint
- Fix pagination examples (LastEvaluatedKey, not ExclusiveStartKey dict)
- Remove non-existent headers param from make_request example
- Fix branch.listbyname example (takes no name arg)
- Add 4 missing wrapper docs: follow, react, trust, votecast
- Fix broken internal links (case-sensitive filenames)
- Fix <environment>_handle_token template artifact
- Add CODE_BUGS.md documenting 4 code bugs found during audit
This commit is contained in:
BarnacleBoy 2026-04-18 22:58:33 +00:00
parent c8611a7b88
commit a223bcb27a
9 changed files with 552 additions and 247 deletions

View file

@ -214,7 +214,7 @@ FileNotFoundError: Token data file 'token_data_alpha.json' not found
**Solutions:**
1. API `<environment>_handle_token` automatically creates file on first use
1. API `handle_token` automatically creates file on first use
2. Ensure working directory is writable
@ -346,7 +346,7 @@ ValueError: Invalid parameter or data format
4. Use debug mode to see request:
```python
API = APIClient(debug=True)
API = APIClient(client_id="your-id", client_secret="your-secret", debug=True)
# Now you'll see the exact data being sent
API.run_job('post.create', data)
@ -389,7 +389,7 @@ FileNotFoundError: Endpoint not found
4. Use debug mode to see exact path being sent:
```python
API = APIClient(debug=True)
API = APIClient(client_id="your-id", client_secret="your-secret", debug=True)
API.run_job('post.create', data) # See exact request path
```
@ -493,7 +493,7 @@ ValueError: Environment 'staging' is not valid. Must be one of: ['alpha', 'produ
API_prod = APIClient(
client_id="prod-id",
client_secret="prod-secret",
env="production"
environment="production"
)
# Old API still has old environment
@ -663,7 +663,7 @@ requests.exceptions.Timeout: Request timed out
API = APIClient(
client_id="your-id",
client_secret="your-secret",
env="alpha",
environment="alpha",
debug=True # Enables verbose logging
)
```