align API docs with java-tron v4.8.2#633
Open
abn2357 wants to merge 6 commits into
Open
Conversation
abn2357
force-pushed
the
align_api_with_482
branch
2 times, most recently
from
8734a00 to
8a631a8
Compare
- Replace node.maxMessageSize error rows with node.http.maxMessageSize and HTTP 413 SizeLimitHandler behavior - Add oversized-body HTTP 413 rows to endpoints that lacked them - Document int64_as_string=true GET flag on applicable endpoints - Add blockTimestamp to JSON-RPC log outputs - Document maxLogFilterNum, maxAddressSize, maxResponseSize, maxBatchSize, and data/input alias handling for eth_call, eth_estimateGas, and buildTransaction - Align documented JSON parse errors with org.tron.json.JSONException after fastjson removal - Expand smart-contract trigger/constant/estimate error response rows with concrete CONTRACT_VALIDATE_ERROR messages - Document JSON-RPC safe block tag handling and eth_newFilter pending/safe errors - Correct JSON-RPC servlet-level error codes for parse errors, invalid requests, oversized responses, batch limits, and internal errors - Clarify unstable JSON-RPC error mappings and parameter-level validation for eth_chainId, net_version, eth_getStorageAt, eth_getLogs, and eth_estimateGas - Update demo JSONObject import to org.tron.json.JSONObject
abn2357
force-pushed
the
align_api_with_482
branch
from
8a631a8 to
6ba046e
Compare
abn2357
force-pushed
the
align_api_with_482
branch
from
4358737 to
7895f89
Compare
Fix POST optional fields and endpoint-specific request schemas. Model
int64_as_string responses, HTTP 404/413 bodies, Lite FullNode text
responses, and shared in-band errors.
Correct required flags verified against java-tron source:
- getaccountbalance: require account_identifier/block_identifier and their
nested address/hash; keep number optional (defaults to 0, only the genesis
block may omit it).
- votewitnessaccount: require vote_address/vote_count on each votes item.
- getblockbyid/getcontract/getcontractinfo: GET value is optional; a missing
value queries empty bytes and returns {}, not an error.
This commit only modifies API spec files (docs/api/specs/http/*.yaml and
docs/api/openapi.yaml); no Markdown documentation is changed.
abn2357
force-pushed
the
align_api_with_482
branch
from
7895f89 to
831fa42
Compare
Audit the HTTP API Markdown against the corrected specs and java-tron source across request, response, and error-response semantics. - Correct Required semantics for defaulted and empty-Protobuf fields, including method-specific GET/POST behavior. - Document conditional contract inputs and the actual estimateenergy request surface. - Correct signature optionality, account permission cardinality, and account type enum forms. - Document Stake 1.0 TRON_POWER behavior and shared rate-limit rejection responses. - Keep the change scoped to Markdown; no spec or OpenAPI files are modified.
abn2357
force-pushed
the
align_api_with_482
branch
from
831fa42 to
db1c55e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Align the HTTP and JSON-RPC API docs with java-tron v4.8.2 behavior.
node.maxMessageSizeerror rows withnode.http.maxMessageSizeand HTTP 413SizeLimitHandlerbehaviorint64_as_string=trueGET flag on applicable endpointsblockTimestampto JSON-RPC log outputsmaxLogFilterNum,maxAddressSize,maxResponseSize,maxBatchSize, anddata/inputalias handling foreth_call,eth_estimateGas, andbuildTransactionorg.tron.json.JSONExceptionafter fastjson removalCONTRACT_VALIDATE_ERRORmessagessafeblock tag handling andeth_newFilterpending/safeerrorsJSONObjectimport toorg.tron.json.JSONObjectTest plan