diff --git a/issues.md b/issues.md index df71984..55461db 100644 --- a/issues.md +++ b/issues.md @@ -1,3 +1,54 @@ +# Issue #138 — Practical API examples + +Status: Completed + +## Description + +Create practical examples demonstrating common API workflows. + +## Tasks +- Add request examples. +- Add response examples. +- Cover authentication flows. +- Include troubleshooting tips. + +## Acceptance Criteria +- Examples are functional. +- Common workflows are documented. +- Contributors can test endpoints easily. + +## Resolution +Implemented in `listener/API.md` with request and response examples, authentication flow documentation, and troubleshooting guidance. + +--- + +# Issue #183 — Comprehensive API reference guide + +Status: Completed + +## Description + +Developers integrating with NotifyChain need a single source of truth for API endpoints, request payloads, response structures, and smart contract events. + +Create a comprehensive reference guide to improve developer onboarding and integration speed. + +## Tasks +- Document all public API endpoints. +- Document request and response schemas. +- Document emitted contract events. +- Include example requests and responses. +- Add authentication requirements. +- Add versioning guidelines. + +## Acceptance Criteria +- Developers can integrate without reviewing source code. +- Event payloads are documented accurately. +- Examples are tested and verified. +- Documentation remains synchronized with current APIs. + +## Resolution +Implemented in `listener/API.md` and related documentation, and this file now reflects the completed status for both issue entries. + # Issue #217 Description @@ -70,4 +121,4 @@ Pagination functions correctly. Search works across supported notification metadata. Contributor Guidelines -git checkout -b feature/notification-search \ No newline at end of file +git checkout -b feature/notification-search