-
Notifications
You must be signed in to change notification settings - Fork 15
Open
Labels
P2-MediumMedium priority - post-beta improvementsMedium priority - post-beta improvementsdocumentationImprovements or additions to documentationImprovements or additions to documentationpost-alphaPost-alpha implementation tasksPost-alpha implementation tasks
Description
Overview
Create comprehensive API documentation for all Proof of Personhood endpoints.
Acceptance Criteria
- Document all endpoints:
- Staking (POST /stake/citizenship, GET /stake/status)
- Vouching (POST /identity/vouch, GET /identity/vouchers)
- Biometric (POST /identity/biometric/verify, GET /identity/biometric/status)
- UBI (GET /ubi/status, GET /ubi/treasury/status)
- Access (POST /dao//access//issue)
- Swap (POST /swap/execute)
- Request/response examples
- Error codes and descriptions
- Rate limiting information
- Authentication requirements
- Pagination documentation
Sections per Endpoint
- Purpose and use case
- Request format (JSON schema)
- Response format (JSON schema)
- Example requests/responses
- Error handling
- Rate limits
Files to Modify
- docs/API/PoP_ENDPOINTS.md (new)
Phase
Phase 5 - Documentation & Migration
Metadata
Metadata
Assignees
Labels
P2-MediumMedium priority - post-beta improvementsMedium priority - post-beta improvementsdocumentationImprovements or additions to documentationImprovements or additions to documentationpost-alphaPost-alpha implementation tasksPost-alpha implementation tasks