hngprojects / hng_boilerplate_python_fastapi_web

Apache License 2.0
154 stars 137 forks source link

[FIX]: Add Expected Data Samples To Docs For All Billing Plan Endpoints #941

Open chimeziriobioha opened 3 weeks ago

chimeziriobioha commented 3 weeks ago

Description

Currently, all billing plan endpoints do not display the expected data samples on the backend documentation for the frontend developers to reference when building relevant UI. This can slow down development due to back and forth between backend and frontend devs to verbally and manually communicate data structure. This ticket seeks to update the docs and address this problem.

Expected Behavior

Frontend developers and others viewing the backend docs should be able to know exactly what to expect from each endpoint.

Screenshots

Current Response Schemas

boilerplate get all billing plan return value boilerplate get single billing plan return value boilerplate patch single billing plan return value boilerplate post billing plan return value

Acceptance Criteria

Testing