KrustyPlanet/trustcafe-api-wrapper
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
117 commits 1 branch 0 tags 320 KiB
Commit graph

117 commits

This branch
This branch
All branches
Author SHA1 Message Date
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
2de47079ab docs: fix documentation.md job name inaccuracies 
- posts.getpublic -> post.listpublic (correct job name)
- listremove -> listremoved (correct job name)
 2026-04-18 02:59:56 +00:00
Jezza Hehn
4f0c06771d docs: fix WRAPPERS.md replacement examples 
- update_post wrapper example now uses correct parameters (post_text, post_path)
- create_comment wrapper example shows post_key parameter option
 2026-04-18 02:59:16 +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
Simon Little
14346ed02e Merge branch 'dev' into 'main' 
0.1.0.13: Following

See merge request trustcafe/trustcafe-api-wrapper!11
 2026-04-16 21:36:06 +00:00
simonwt
98eed5454f Remove the snippet file 2026-04-16 22:35:18 +01:00
simonwt
e2c6e9e3a7 Update dev doc and version 2026-04-16 22:33:38 +01:00
simonwt
e47a9aa568 Real test and update to tests 2026-04-16 22:20:11 +01:00
simonwt
41102d5348 Follow 2026-04-16 21:58:31 +01:00
simonwt
0bcec8163c Wrappers accept item_key where possible 
More tests
 2026-04-16 21:31:32 +01:00
simonwt
7db5a29081 Raise HTTP errors 2026-04-16 21:13:06 +01:00
simonwt
cd1f0a2ae3 Return token data from handle_token 
Notes for dev
 2026-04-16 21:08:54 +01:00
Simon Little
89fc8706cb Merge branch 'dev' into 'main' 
Dev

See merge request trustcafe/trustcafe-api-wrapper!10
 2026-04-13 21:48:19 +00:00
simonwt
5705c05189 Documentation and version 2026-04-13 22:47:20 +01:00
simonwt
8453c10efe Allow comments to be passed a key instead of path 2026-04-13 22:31:11 +01:00
simonwt
deb19d78ae Handle token method for saving token token to a file 2026-04-13 22:26:42 +01:00
simonwt
dcc5cb1cb6 Merge branch 'main' into dev 2026-04-13 21:58:23 +01:00
simonwt
0a76b6e7f8 Acccept pk sk as well as path when updating post 2026-04-13 21:56:42 +01:00
Simon Little
a646997a1c Merge branch 'python311' into 'main' 
Update version

See merge request trustcafe/trustcafe-api-wrapper!9
 2026-04-13 17:26:44 +00:00
simonwt
0b5afa6755 Update version 2026-04-13 18:26:24 +01:00
Simon Little
fb2d4ada62 Merge branch 'python311' into 'main' 
Allow python 3.11

See merge request trustcafe/trustcafe-api-wrapper!8
 2026-04-13 17:23:43 +00:00
simonwt
206c5ce242 Allow python 3.11 2026-04-13 18:23:22 +01:00
Simon Little
ac4eff59f6 Merge branch 'python311' into 'main' 
Allow python 3.11

See merge request trustcafe/trustcafe-api-wrapper!7
 2026-04-13 17:19:14 +00:00
simonwt
3d8ed468d7 Allow python 3.11 2026-04-13 18:17:37 +01:00
Simon Little
0476c3fe9f Merge branch 'dev' into 'main' 
Mark notifications as read

See merge request trustcafe/trustcafe-api-wrapper!6
 2026-04-13 16:45:24 +00:00
simonwt
c20ec05e4b Update version 2026-04-13 17:44:27 +01:00
simonwt
1b50309c09 List notifications 2026-04-13 17:43:52 +01:00
Simon Little
81680d91b1 Merge branch 'dev' into 'main' 
WIP

See merge request trustcafe/trustcafe-api-wrapper!5
 2026-04-08 23:42:20 +00:00
simonwt
921b6f5d95 docs 2026-04-09 00:41:48 +01:00
simonwt
72a49285c1 Version 2026-04-09 00:36:47 +01:00
simonwt
ae6ee7e7a0 Fix public 
Add guest alternative
Write some doc
 2026-04-09 00:34:23 +01:00
simonwt
eabca3e7bf Merge branch 'dev' of https://gitlab.com/trustcafe/trustcafe-api-wrapper into dev 2026-04-08 12:17:30 +01:00
simonwt
adef4fa8aa testing removed 2026-04-08 12:17:26 +01:00
simonwt
a42a3b65d9 Post update 2026-04-07 23:37:55 +01:00
simonwt
1995e0479f Merge remote-tracking branch 'origin/main' into dev 2026-04-07 22:38:46 +01:00
simonwt
c646e7ddbc More APIclient testing 2026-04-07 22:38:34 +01:00
simonwt
590fae1407 changing environment variables 2026-04-07 22:32:13 +01:00
Simon Little
edb7b2f426 Merge branch 'dev' into 'main' 
Version

See merge request trustcafe/trustcafe-api-wrapper!4
 2026-04-07 20:59:21 +00:00
simonwt
0072e40c5a Version 2026-04-07 21:58:47 +01:00
Simon Little
f4c373a4ce Merge branch 'dev' into 'main' 
List removed posts

See merge request trustcafe/trustcafe-api-wrapper!3
 2026-04-07 20:57:37 +00:00
simonwt
766ff5b69d Tested and fixed trust createorupdate 2026-04-07 21:54:52 +01:00
simonwt
255d6ef37b Fix tested get removed 2026-04-07 19:50:17 +01:00
simonwt
2b608be054 List removed posts 
Last evaluated key for pagination
 2026-04-07 19:48:14 +01:00
Simon Little
e1a8e008e1 Update .gitlab-ci.yml file 2026-04-07 13:06:08 +00:00
Simon Little
42d6750cca Merge branch 'dev' into 'main' 
Update ci cd

See merge request trustcafe/trustcafe-api-wrapper!2
 2026-04-07 12:16:53 +00:00
simonwt
b675a23de8 Update ci cd 2026-04-07 13:16:21 +01:00