search

onflow / flow-jvm-sdk

Flow JVM SDK
Apache License 2.0
16 stars 16 forks source link

Update docs for added examples - execution data/streaming #105

Closed lealobanov closed 1 month ago

lealobanov commented 1 month ago

Description

Update docs to account for recently added examples for getting execution data and streaming via subscription endpoints.

For contributor use:

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve updates to the README files for both Java and Kotlin examples. A new section titled "Get Execution Data" has been added to both README files, providing descriptions and links to code examples for retrieving execution data by block ID. Additionally, the Kotlin README includes a new section on "Streaming Events and Execution Data," which replaces outdated information regarding unsupported features. The overall structure of the documentation remains intact, with no deletions or modifications to existing content.

Changes

File Path Change Summary
java-example/README.md Added new entry "Get Execution Data" in "Examples summary" table with a link to the Java example.
kotlin-example/README.md Added "Get Execution Data" and "Streaming Events and Execution Data" sections in "Examples summary." Removed unsupported features related to streaming events.

Possibly related PRs

Suggested reviewers

🐰 In the meadow, changes bloom,
New examples chase away the gloom.
With data retrieval, swift and bright,
Our docs now shine, a guiding light!
From Java to Kotlin, all can see,
How to fetch data, hop with glee! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` - `@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 generate unit testing code.` - `@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.` 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 1 month ago

Unit Test Results

  53 files  ±0    53 suites  ±0   24s :stopwatch: ±0s 310 tests ±0  310 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit 170bf2cf. ± Comparison against base commit 170bf2cf.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 1 month ago

SDK Examples Unit Test Results

16 files  16 suites   2m 44s :stopwatch: 32 tests 31 :heavy_check_mark: 0 :zzz: 1 :x:

For more details on these failures, see this check.

Results for commit fda83e46.

github-actions[bot] commented 1 month ago

Common Integration Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit fda83e46.

github-actions[bot] commented 1 month ago

Integration Test Results

  6 files  ±0    6 suites  ±0   2m 35s :stopwatch: ±0s 30 tests ±0  30 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit 170bf2cf. ± Comparison against base commit 170bf2cf.

:recycle: This comment has been updated with latest results.