Skip to content

Conversation

thephez
Copy link
Collaborator

@thephez thephez commented Aug 18, 2025

Issue being fixed or feature implemented

The WASM SDK documentation generation was producing incorrect parameter descriptions for identityCreate and identityTopUp state transitions. The generated documentation showed UI-oriented parameters instead of the actual SDK method signatures, causing confusion for developers using the SDK.

What was done?

  • Added sdk_params and sdk_example fields to api-definitions.json for identityCreate and identityTopUp transitions with
    correct SDK method parameters
  • Updated generate_docs.py to use sdk_params when available for documentation generation while maintaining UI compatibility
  • Corrected parameter descriptions to match v2.1-dev format exactly
  • Regenerated docs.html and AI_REFERENCE.md with accurate SDK method signatures and examples

The solution maintains backward compatibility for the UI (index.html) while providing accurate documentation for SDK
consumers.

How Has This Been Tested?

  • Verified generated documentation matches v2.1-dev output
  • Tested documentation generation script produces consistent output

Breaking Changes

None. This change only affects documentation generation and maintains full compatibility with existing UI and SDK functionality.

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
  • I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

thephez and others added 3 commits August 18, 2025 15:24
Add sdk_params to api-definitions.json and update generate_docs.py to use them for accurate SDK documentation while preserving UI compatibility.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
…criptions

Update generated docs.html and manifest to reflect accurate SDK method signatures for identity create/topup operations.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
…n parameters

Regenerate AI_REFERENCE.md to reflect accurate SDK method signatures and parameter descriptions for identity create/topup operations.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Copy link
Contributor

coderabbitai bot commented Aug 18, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@thephez thephez requested a review from pauldelucia August 18, 2025 20:10
@thephez
Copy link
Collaborator Author

thephez commented Aug 18, 2025

Related to #2728

@QuantumExplorer QuantumExplorer merged commit b8a7ba5 into dashpay:feat/implement-missing-token-transitions-wasm-sdk Aug 19, 2025
6 checks passed
lklimek pushed a commit that referenced this pull request Sep 1, 2025
Co-authored-by: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants