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

Document API with OpenAPI spec (API 1.1) #420

Open
wants to merge 49 commits into
base: next
Choose a base branch
from
Open

Conversation

krestenlaust
Copy link
Member

@krestenlaust krestenlaust commented Apr 7, 2024

In order to make the use of the API more welcoming, the API should be formally described as an OpenAPI specification.

Endpoints:

  • api/member
  • api/member/balance
  • api/member/get_id
  • api/member/active
  • api/member/sales
  • api/member/payment/qr
  • api/products/named_products
  • api/products/active_products
  • api/products/category_mappings
  • api/sale

@krestenlaust krestenlaust marked this pull request as draft April 7, 2024 18:01
@krestenlaust krestenlaust changed the title Document API with OpenAPI spec Document API with OpenAPI spec (API 1.1) Apr 8, 2024
Copy link

codecov bot commented May 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.83%. Comparing base (294159e) to head (507688b).
Report is 9 commits behind head on next.

Current head 507688b differs from pull request most recent head 51ba904

Please upload reports for the commit 51ba904 to get more accurate results.

Additional details and impacted files
@@             Coverage Diff             @@
##             next     #420       +/-   ##
===========================================
+ Coverage   53.49%   80.83%   +27.33%     
===========================================
  Files          33       33               
  Lines        4621     3047     -1574     
  Branches      274      255       -19     
===========================================
- Hits         2472     2463        -9     
+ Misses       2097      545     -1552     
+ Partials       52       39       -13     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@krestenlaust krestenlaust marked this pull request as ready for review October 24, 2024 14:36
Copy link

@AshesOfEther AshesOfEther left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks mostly good. I suggest using the sample instance of Swagger UI to check that it's right. Perhaps we could publish that on a docs site of our own? That's out of scope for this PR though.

openapi/openapi.yaml Outdated Show resolved Hide resolved
openapi/openapi.yaml Outdated Show resolved Hide resolved
openapi/openapi.yaml Outdated Show resolved Hide resolved
@krestenlaust krestenlaust marked this pull request as draft November 3, 2024 00:26
@krestenlaust krestenlaust marked this pull request as ready for review November 3, 2024 00:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make documentation for Stregsystem Rest API
2 participants