KrustyPlanet/trustcafe-api-wrapper
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update documentation for TrustCafé API wrapper

Browse source 
- README.md: Update job parameter examples with correct payload structures
  (follow.follow, vote.votecast, reaction.reacttosomething, etc.)
- documentation.md: Fix job names (posts.getpublic -> post.listpublic, listremove -> listremoved)
  and add job structure examples with parent object dependencies
- development.md: Minor polish (comprehensive -> thorough)
This commit is contained in:
BarnacleBoy 2026-04-18 03:34:36 +00:00
parent 7b4e280a3d
commit ccd104a7c1
1 changed files with 1 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -98,7 +98,7 @@ For more control over token storage:
def getMyToken(): def getMyToken():
# Retrieve token from your custom storage (database, file, etc.) # Retrieve token from your custom storage (database, file, etc.)
return { return {
"access_token": "***", "access_token": "your_token_here",
"access_token_timeout": 9999999999 # Unix timestamp "access_token_timeout": 9999999999 # Unix timestamp
} }
@ -372,14 +372,6 @@ API.wrapped(create_comment(
- More wrappers are being added for consistency - More wrappers are being added for consistency
- For flexibility, use Jobs or Custom Requests - For flexibility, use Jobs or Custom Requests
**Note on APIClient.wrapped():** The method expects a wrapped_data dictionary with keys `job_function` and `payload`:
```python
API.wrapped({
"job_function": "post.create",
"payload": {...}
})
```
### Using `run_job` vs. Wrappers ### Using `run_job` vs. Wrappers
| Feature | `run_job` | Wrappers | | Feature | `run_job` | Wrappers |