Issue 10: API Documentation & Schema

[Tinna23]

Description

Document the API using OpenAPI.

Tasks

• Integrate OpenAPI via utoipa
• Document response fields
• Provide example responses

Acceptance Criteria

• Swagger UI accessible
• API contract is stable
• Documentation matches responses

[drips-wave]

This issue has been added to the Stellar Wave Program and is worth 150 Points.

🧑‍💻 Interested in contributing? Apply to work on this issue on Drips Wave, earn points, and receive rewards.

🤠 Repo maintainers: You can manage this issue's Points and Complexity on your Maintainer Dashboard here. Please keep an eye on applications and respond quickly 💙

ℹ️ Learn more about Drips Wave

[soma-enyi]

@soma-enyi has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

Hi Maintainer!!!
I will like to work on this issue!!!

ℹ️ Repo Maintainers: To accept this application, review their application or assign @soma-enyi to this issue.

[devJaja]

@devJaja has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

Hello, I am a smart contract developer, open for contributions. contributed to over 20 project on OnlyDust, with expertise in Solidity, Cairo, TypeScript, and JavaScript. I am passionate about building secure and scalable blockchain solutions, and I would love the opportunity to contribute my skills toward solving this issue

ℹ️ Repo Maintainers: To accept this application, review their application or assign @devJaja to this issue.

[Rajkoli145]

@Rajkoli145 has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

Hi
I’d like to take this issue.

I’ll integrate OpenAPI using utoipa, document all existing endpoints with accurate schemas, response fields, and example payloads, and expose a Swagger UI that stays in sync with the actual API behavior. I’ll keep the contract stable and ensure the docs strictly match real responses.

I can start immediately. Thanks!

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Rajkoli145 to this issue.

[Properprogress1]

@Properprogress1 has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

I'd love to work on this task and I am confident of doing a great job

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Properprogress1 to this issue.

[icedoutskay]

@icedoutskay has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

Hello maintainer, I would like to be assigned this issue.
I have experience working with swagger and openai documentation

ℹ️ Repo Maintainers: To accept this application, review their application or assign @icedoutskay to this issue.

[Jayydy]

@Jayydy has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

I have some experience producing clear, accurate API documentation and well-defined schemas that improve developer adoption and reduce integration errors.
My focus will be on consistency, maintainability, and alignment between implementation and documentation.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Jayydy to this issue.

[Ibinola]

@Ibinola has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

I have some experience producing clear, accurate API documentation and well-defined schemas, can you please assign

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Ibinola to this issue.

[codewithzubair07]

@codewithzubair07 has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

Hi maintainers 👋

I’d like to work on API Documentation & Schema. This is a valuable improvement for consumers of the API, and I’m comfortable documenting Rust APIs using OpenAPI with utoipa.

My approach would be:

Integrate OpenAPI generation via utoipa

Document all response fields with accurate schemas

Add clear example responses

Expose Swagger UI and ensure documentation matches actual API behavior

I’ve worked on API documentation before and focus on keeping contracts stable, accurate, and easy to consume. I’ll keep the changes scoped and easy to review.

Happy to proceed once assigned and adjust based on feedback.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @codewithzubair07 to this issue.

[okekefrancis112]

@okekefrancis112 has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

I’d like to work on this issue because it addresses a core backend concern around reliability, correctness, and scalability. I enjoy contributing to backend features that improve system behavior, data integrity, and developer experience.

I have strong experience building and maintaining backend systems using NestJS, Node.js, TypeScript, SQL/NoSQL databases, and RESTful APIs. I’ve worked on production features involving data modeling, validation, background processing, performance optimization, and debugging complex edge cases. I’m comfortable reading existing codebases, following established patterns, writing tests where appropriate, and shipping well-documented changes that integrate cleanly with frontend and infrastructure requirements.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @okekefrancis112 to this issue.

[ReinaMaze]

@ReinaMaze has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

I’d like to apply for this issue and kindly request to be assigned.
I’ve reviewed the requirements and I’m confident I can deliver the solution as described. I have open-source contribution experience and I’ll follow the project guidelines to ensure the implementation is clean, tested, and meets the acceptance criteria.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @ReinaMaze to this issue.

[solomonadzape95]

@solomonadzape95 has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

Hi StellarCommons,
I'm Solomon and I'm a fullstack developer with 3+ years of experience building both on web2 and web3. I would like to take on the OpenAPI integration for the Stellar Fee Tracker. I have experience using utoipa to generate compile-time documentation for Rust-based APIs, ensuring the Swagger UI stays perfectly in sync with the codebase.

My approach to this task:

• Type-Safe Documentation: I’ll implement ToSchema and IntoParams on all DTOs to ensure the API contract is automatically derived from the code.
• Comprehensive Coverage: I will document all response fields, error codes (404, 429, 500), and provide realistic JSON examples for fee-tracking endpoints.
• Interactive UI: I’ll ensure the Swagger UI is properly routed and accessible for immediate testing by other contributors.

Why me? I deliver clean, stable API contracts and follow a "documentation as code" philosophy. I can get this integrated and verified against your current responses quickly.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @solomonadzape95 to this issue.

[CharlesChinedum]

@CharlesChinedum has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

I’d like to integrate OpenAPI documentation into Stellar Fee Tracker using utoipa to provide clear, up-to-date API references. I’ll document all response fields, provide example responses, and ensure the API contract is stable and accurately reflects current behavior.

The documentation will be accessible via Swagger UI, giving developers an interactive and reliable interface to explore and test the API. This will improve developer onboarding and maintain API clarity as the project evolves.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @CharlesChinedum to this issue.

[Uyoxy]

@Uyoxy has applied to work on this issue as part of the Stellar Wave Program's 1st wave.

I’m a full-stack developer experienced in both frontend and backend development, and I’m happy to contribute to UI work, APIs, backend logic, testing, and documentation.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Uyoxy to this issue.