search

algorand / go-algorand

Algorand's official implementation in Go.
https://developer.algorand.org/
Other
1.34k stars 462 forks source link

Missing LedgerStateDelta from OAS spec (and therefore documentation and other SDKs apart from Go) #5901

Open FrankSzendzielarz opened 6 months ago

FrankSzendzielarz commented 6 months ago

Subject of the issue

LedgerStateDelta is not defined in the OAS specs. Go SDK defines it here https://github.com/algorand/go-algorand-sdk/blob/develop/types/statedelta.go

Seeing as the SDKs and docs are driven by the OAS spec, LedgerStateDeltas seem to be missing from the other SDKs and the docs here: https://developer.algorand.org/docs/rest-apis/algod/#ledgerstatedelta

Expected behaviour

The object model needs to be added to the OAS2 and 3 specs.

gmalouf commented 6 months ago

Hey Franz - thanks for the report. There were some technical limitations we ran into that resulted in this decision at the time: #5123 might give some insight.

Additionally, there are other objects that are not defined in the spec:

For Python and Javascript, almost everything is a mystery type so this has not been an issue to date. We may want to revisit this decision down the line/figure out an alternative option to get support back.