-
Notifications
You must be signed in to change notification settings - Fork 51
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
Improve API (API 1.1) #421
Conversation
The other endpoints use 'Invalid ID' to signify either missing or invalid. This endpoint used to use 'Invalid Username' to signify that the member does not exist, while the other's would've used 'Member not found' for that.
There's an inconsistency in whether to call a member a user. Generally, users are the ones with admin access, while members are the customers.
0a51575
to
1b2a2e5
Compare
Even though it's a bool, I believe it's more appropriate to keep the naming consistent with non-bool return types. Also, it still returns an object.
I won't rename the actual endpoint because of backwards compatibility.
QR-endpoint apparently uses Stregdollars as opposed to Stregøre. I feel like streamlining this is too big a change. |
More meaningful response in Active Products-endpoint, now returns {"1": {"name": "Beer", "price": 600}}, instead of {"1": ["Beer", 600]}
Changed response format for Active Products-endpoint: Instead of |
Changed format for Category_mapping endpoint output: Much more verbose, but it's more like the other endpoints. Considering changing it to not return products which don't have any mapped categories |
I've decided to leave the sales API as is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a few small changes, but looks nice 👍
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## next #421 +/- ##
==========================================
- Coverage 80.82% 80.63% -0.20%
==========================================
Files 40 40
Lines 3760 3774 +14
Branches 476 480 +4
==========================================
+ Hits 3039 3043 +4
- Misses 665 675 +10
Partials 56 56 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
* Add initial OpenAPI spec * Add endpoint categories * Update info and add version * Define API endpoint * Finish Get Member Info-endpoint * Finish Get Member Balance-endpoint * Correct descriptions and add missing descriptions * Update schemas to include member_id and username * Finish Get Member ID-endpoint * Bump version to fit version in #421 * Rename operation IDs to URL names * Finish Get Member Active-endpoint * Finish Get Member Sales-endpoint * Rename product_price schema * Finish Get Payment QR-Endpoint * Add NamedProducts-Endpoint * Add response for missing param, refactor res-value * Rename stregdollar to stregoere This was done to make it more clear, what the value actually is * Refactor named_products schemas * Add Active Products-endpoint * Draft category mapping-Endpoint * Finish Dump Category Mapping-endpoint * Progress related to documenting Sale-API * Expand Sale-API response * Add Ballmer-peak measures * Fix invalid response format * Fix wrong keywords * Reduce 200-example * Make api/member-endpoint valid * Make multiple api/member/*-endpoints valid * fixup! Make multiple api/member/*-endpoints valid * Make endpoints requiring room_id valid * Make api/sale-endpoint valid * Make 'api/member/payment/qr'-endpoint valid * Remove old individual responses * Make '/api/member/get_id'-endpoint valid * Change description to be more intuitive * Add request body to 'api/sale'-endpoint * Made request-example coherent with response-example * Add description to 'api/sale'-endpoint * Add local endpoint as server * Rename file to stregsystem.yaml * Rename parameters to unique IDs * Convert examples as schemas into examples * Rename operationIds to fit changes in #421
#420 aims to document the API. This PR addresses inconsistencies found during that documentation effort. Both in implementation and in the actual API.
It increments the API versioning to 1.1