Docs: Update API docs, remove unused codegen configs#4896
Docs: Update API docs, remove unused codegen configs#4896algorandskiy merged 2 commits intoalgorand:masterfrom
Conversation
Eric-Warehime
requested review from
algochoi,
jasonpaulos,
letonchanh,
michaeldiamant and
winder
Codecov Report
@@ Coverage Diff @@
## master #4896 +/- ##
==========================================
- Coverage 54.06% 54.04% -0.02%
==========================================
Files 427 427
Lines 53520 53520
==========================================
- Hits 28935 28927 -8
- Misses 22316 22325 +9
+ Partials 2269 2268 -1
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
jasonpaulos
left a comment
jasonpaulos
left a comment
There was a problem hiding this comment.
Looks like a good improvement to me, but I did want to point out an issue I noticed that deserves some thought.
| endpoints based on the use case for the node. | ||
|
|
||
| Each API in `algod.oas2.json`, except for some pre-existing `common` APIs, should have two tags. | ||
| 1. Either `public` or `private`. This controls the type of authentication used by the API--the `public` APIs use the |
There was a problem hiding this comment.
If the goal is to have the data endpoints use admin authentication, but also be visible by the SDKs, something needs to change, since they will ignore private endpoints.
There was a problem hiding this comment.
I ended up switching the new data endpoints to public for this reason.
There was a problem hiding this comment.
Got it. Adding a link to #4900 in case anyone else is following this
6 participants
Summary
Updates Readme in the algod api directory to include a short summary of the tag usage for the V2 APIs.
Also deleted some of the initial codegen configs that were created during the transition to separating the APIs.
make clean && makereturns no diffs in the generated code which I used to confirm they were indeed unused.