docs: Add comprehensive API documentation#234
Open
jiarong901013-source wants to merge 1 commit intoANAVHEOBA:mainfrom
Open
docs: Add comprehensive API documentation#234jiarong901013-source wants to merge 1 commit intoANAVHEOBA:mainfrom
jiarong901013-source wants to merge 1 commit intoANAVHEOBA:mainfrom
Conversation
- OpenAPI 3.0 specification for all contract functions - Complete contract ABI documentation with examples - JavaScript code examples (deposit, withdraw, query) - Postman collection for API testing - Swagger UI compatible format Fixes #62
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds complete API documentation for the PrivacyLayer contract.
Deliverables
✅ OpenAPI 3.0 Specification (api-docs/openapi.yaml)
✅ Contract ABI Documentation (api-docs/contract-abi.json)
✅ JavaScript Examples (api-docs/examples/)
✅ Postman Collection (api-docs/postman/)
✅ README (api-docs/README.md)
Testing
All examples follow the contract interface in contracts/privacy_pool/src/contract.rs.
Related Issue
Fixes #62