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

Setup OpenAPI merger #8

Open
Tracked by #10
robcxyz opened this issue Sep 29, 2024 · 0 comments
Open
Tracked by #10

Setup OpenAPI merger #8

robcxyz opened this issue Sep 29, 2024 · 0 comments

Comments

@robcxyz
Copy link
Contributor

robcxyz commented Sep 29, 2024

We need to combine all the OpenAPI docs into one from https://tracker.icon.community/ > tools > api docs > All of these... All the endpoints are already in the initial PR commit

Branch: https://github.com/sudoblockio/icon-stats/tree/openapi-merger
PR: #7 -> See PR for files relating to this feat.

Bring over the merger from https://github.com/sudoblockio/sb-pocs/blob/main/apisix/openapi_merger

Most has been just copied over but missing main.py which should not be needed because code is called from API with a cache. https://github.com/sudoblockio/icon-stats/blob/openapi-merger/icon_stats/api/v1/endpoints/openapi.py

There are five endpoints which should be the input to the merger. The merger in the POC is a CLI and so basically the code in the icon_stats/openapi dir will hopefully be generic so that it can be reused later. Not a huge priority now though as we just need to ship the merger for the grant.

Test should make the calls and validate the inputs. Might need to pull out logic from API so that this is more testable (ie the endpoints / endpoint_suffixes stuff). Don't need to test the API directly.

@robcxyz robcxyz mentioned this issue Sep 29, 2024
2 tasks
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