BarnacleBoy
ccd104a7c1
Update documentation for TrustCafé API wrapper
...
- 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)
2026-04-18 03:44:25 +00:00
BarnacleBoy
7b4e280a3d
Update documentation for APIClient.wrapped and WRAPPERS.md
...
- Fixed APIClient.wrapped() doc to use job_function instead of job
- Updated WRAPPERS.md parameter tables:
- update_post(): Corrected all parameters (post_text, post_path, parent_path, post_key, blur_label, card_url, collaborative)
- create_comment(): Made parent_path optional, added comment_text requirement, clarified post_slug/post_key alternatives
# Conflicts:
# docs/WRAPPERS.md
2026-04-18 03:44:21 +00:00
Jezza Hehn
7e0244d49c
docs: fix README examples for follow, vote, reaction jobs
...
- follow.follow requires payload dict, not username string
- vote.votecast uses 'vote' not 'voteType', and has parent structure
- reaction.reacttosomething uses 'reaction' and 'parent', not 'reactionType' and 'objectPK/SK'
- feed.following -> feed.followingfeed
- branch.listbyname doesn't take prefix parameter
2026-04-18 02:58:30 +00:00
Jezza Hehn
17d6ed69d1
docs: fix more parameter mismatches and job name inaccuracies
...
- Fix feed.following -> feed.followingfeed (actual function name)
- Fix branch.listbyname: doesn't filter by name, just lists branches with pagination
- Fix branch.get: parameter is branch_slug not branchName
- Fix follow.follow: takes payload dict, not username string
- Add pagination parameter docs for feed.cafefeed and feed.followingfeed
- Revert GitLab URL changes (correct - points to upstream repo)
2026-04-18 02:57:41 +00:00
Jezza Hehn
e7cf4f1e09
docs: fix parameter mismatches and inaccurate documentation
...
- Fix update_post() wrapper documentation (post_id -> post_text/post_path/post_key)
- Fix create_comment() wrapper documentation (added post_slug, post_key parameters)
- Add missing wrapper docs for follow(), trust(), votecast(), react()
- Fix reaction job parameters (parent_id -> parent_sk, corrected payload structure)
- Fix trust job parameters (updated to match actual payload structure)
- Fix vote job parameters (voteType -> vote, added parent structure)
- Clearly mark Block and Mute jobs as NOT IMPLEMENTED
- Fix GitLab URLs to Forgejo (git.jezzahehn.com)
- Remove LLM-style language (comprehensive -> full/thorough)
- Fix trust listbyusersinit parameter (username -> user_id)
2026-04-18 02:47:33 +00:00
BarnacleBoy
fd1a1566e9
chore: add comprehensive API wrapper documentation
...
- Add docs/ directory with 6 comprehensive documentation files:
* INDEX.md - Main navigation and documentation index
* GETTING_STARTED.md - Setup and configuration guide
* API_REFERENCE.md - Complete API documentation
* WRAPPERS.md - High-level wrappers guide
* CUSTOM_REQUESTS.md - Advanced usage patterns
* TROUBLESHOOTING.md - Problem-solving guide
- Update README.md with enhanced project information
- Update development.md with expanded documentation context
Extends previous session's documentation work with complete
developer and user-facing documentation.
Closes previous documentation issue.
2026-04-18 02:35:56 +00:00
simonwt
1b50309c09
List notifications
2026-04-13 17:43:52 +01:00
simonwt
7bca418530
Documentation
2026-04-02 17:55:01 +01:00
simonwt
f4a66b3e55
Updating readme
2026-04-02 17:31:39 +01:00
simonwt
c27a89b8f9
wrapped function to condense code
2026-04-01 21:31:15 +01:00
simonwt
c5d074d178
Todo
...
Make comments
2026-03-31 20:04:08 +01:00
simonwt
620553ea14
Comment create
2026-03-31 12:00:49 +01:00
simonwt
f07cf0e02d
change name to remove dashes and hopefully be importable
2026-03-30 23:05:49 +01:00
simonwt
bfe42ef1a1
Clear readme
2026-03-30 21:56:03 +01:00
Simon Little
b5b3681843
Initial commit
2026-03-30 16:13:28 +00:00
