Skip to content

Add the 14 missing functions to docs/api-reference.md #521

Closed

Description

@Austinaminu2

File: docs/api-reference.md, docs/README.md:34
Both claim "all 12 public functions" are documented, but contracts/streaming/src/lib.rs exposes 26 (grep -n "pub fn " lib.rs). Missing: initialize, pause, unpause, upgrade, migrate, create_streams_batch, get_archived_sent_streams, get_archived_received_streams, cleanup_stream, update_stream_metadata, get_stream_metadata, version, name, set_delegate, remove_delegate, get_delegate. Follow the existing per-function doc pattern (signature, params, behavior, errors) already used for the 12 documented ones, and update the "12 public functions" claim to the correct count.


Activity

  1. joshfatoye0011-bit commented on Aug 20, 2026

    @joshfatoye0011-bit
    Contributor

    my expertise would be highly needed on this project

  2. grantfox-oss commented on Aug 20, 2026

    @grantfox-oss

    🦊 GrantFox — @joshfatoye0011-bit has been assigned to this issue as part of the Third Campaign campaign!

    Next steps:

    1. Open a Pull Request referencing this issue (e.g., Closes #521)
    2. Your PR will be reviewed by the FlowwStar maintainers

    Good luck! Track your progress on GrantFox.

  3. grantfox-oss commented on Aug 25, 2026

    @grantfox-oss

    🎉 This issue has been marked as completed on GrantFox as part of the Third Campaign campaign!

    @joshfatoye0011-bit's PR #621 was approved and merged by @Austinaminu2.

    🏆 @joshfatoye0011-bit: You earned 35 FoxPoints for this contribution! Your current tier: Explorer (522 total points). Track your full progress on GrantFox.

    👏 Great work, @joshfatoye0011-bit! Keep contributing to FlowwStar.

  4. added a commit that references this issue on Aug 26, 2026
    d05cff6
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardThird CampaignCampaign: Third CampaigndocumentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions