Skip to content

docs: view all client methods inside api reference #79

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

Jump to bottom
Merged
merged 1 commit into from
Jul 30, 2025
Merged

docs: view all client methods inside api reference #79

merged 1 commit into from
Jul 30, 2025

Conversation

@MicBun
Copy link
Member

@MicBun MicBun commented Jul 30, 2025 •
edited by coderabbitai bot
Loading

Add missing api-reference methods

Summary by CodeRabbit

  • Documentation
    • Expanded the API reference with detailed descriptions and usage examples for new and enhanced client methods, including batch record insertion, advanced stream querying, stream and composition management, role management, and improved visibility and permission controls. The documentation now covers additional batch operations, richer querying, and more comprehensive management APIs.
@MicBun MicBun requested a review from outerlook July 30, 2025 09:50
@MicBun MicBun self-assigned this Jul 30, 2025
@MicBun MicBun added the documentation Improvements or additions to documentation label Jul 30, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 30, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The API reference documentation for the TRUF.NETWORK Python SDK was substantially expanded. New entries describe batch operations, advanced querying, enhanced stream and role management, and detailed visibility/permission controls. Method signatures, parameters, return types, and usage examples were added or updated to reflect the SDK's broadened capabilities.

Changes

Cohort / File(s) Change Summary
API Reference Expansion
docs/api-reference.md		 Added comprehensive documentation for new and updated SDK methods: batch operations, querying, stream/role management, and visibility/permission controls. Includes method signatures, parameter/return details, and usage examples.

Sequence Diagram(s)

sequenceDiagram participant User participant TNClient participant Blockchain User->>TNClient: batch_insert_records(batches, wait) TNClient->>Blockchain: Insert multiple record batches (single transaction) Blockchain-->>TNClient: Transaction hash TNClient-->>User: Return transaction hash User->>TNClient: list_streams(limit, offset, ...) TNClient->>Blockchain: Query streams with filters Blockchain-->>TNClient: Stream list TNClient-->>User: Return streams User->>TNClient: allow_compose_stream(stream_id, wait) TNClient->>Blockchain: Update compose permissions Blockchain-->>TNClient: Transaction hash TNClient-->>User: Return transaction hash
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐇
In docs I hopped and left my mark,
With batch and stream and roles to spark,
Permissions clear, examples bright,
Compose and query day or night.
Now every bunny, near and far,
Can code with docs as clear as stars!
✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 32d8633 and b3e6135.

📒 Files selected for processing (1)
  • docs/api-reference.md (6 hunks)
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docsAllApiRef

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.
@pr-time-tracker
Copy link

pr-time-tracker bot commented Jul 30, 2025 •
edited
Loading

Time Submission Status

Member Status Time Action Last Update
MicBun ✅ Submitted 1h Update time Jul 30, 2025, 10:41 AM
@MicBun MicBun merged commit a01f9ec into main Jul 30, 2025
5 of 6 checks passed
@MicBun MicBun changed the title docs: include all client methods inside api reference docs: view all client methods inside api reference Jul 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

2 participants

@MicBun