Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
2 tasks
chimeziriobioha opened this issue Aug 23, 2024 · 0 comments
Open
2 tasks

Comments

@chimeziriobioha
Copy link
Contributor

chimeziriobioha commented Aug 23, 2024

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

  • Stick to the changes required to fix the particular bug mentioned in description.
  • Do not change other people's code without appropriate permission.

Testing

  • Write test for all updates requiring one
  • Ensure all existing tests passes [without tampering], alongside the new ones added
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant