Skip to content

Commit fd1c76f

Browse files
committed
add better descriptions
1 parent 68047e6 commit fd1c76f

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

ecosystem/rpc/toncenter/v3.yaml

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1411,8 +1411,7 @@ paths:
14111411
$ref: '#/components/schemas/RequestError'
14121412
/api/v3/runGetMethod:
14131413
post:
1414-
description: 'Run get method of smart contract. Stack supports only `num`, `cell`
1415-
and `slice` types.'
1414+
description: 'Executes a read only get-method of a smart contract. Use this endpoint to call TVM methods without creating a transaction onchain. The request must include the method name and "stack" array with input arguments.'
14161415
tags:
14171416
- Legacy (v2-compatible)
14181417
summary: Run smart contract get-method
@@ -2905,10 +2904,31 @@ components:
29052904
type: string
29062905
V2StackEntity:
29072906
type: object
2907+
required: ["type", "value"]
2908+
description: "Represents one argument passed to a TVM get-method call. Each argument has a type and a value."
29082909
properties:
29092910
type:
29102911
type: string
2911-
value: {}
2912+
description: 'Specifies the data type of this stack argument. Use "int", "uint", or "num" for numbers; "cell", "slice", or "builder" for base64-encoded BOC strings; "address" for TON addresses; "tuple" or "list" for arrays of nested arguments; or "null" when the value is empty.'
2913+
enum:
2914+
- "int"
2915+
- "uint"
2916+
- "num"
2917+
- "cell"
2918+
- "slice"
2919+
- "builder"
2920+
- "address"
2921+
- "tuple"
2922+
- "list"
2923+
- "null"
2924+
value:
2925+
description: 'Holds the actual value for this argument. For numeric types, use a decimal or hex string (for example "1435" or "0x7B"). For cell, slice, or builder, use a base64-encoded BOC string. For address, use a TON address string. For tuple or list, provide an array of nested stack items. The value can be null if no data is expected.'
2926+
nullable: true
2927+
anyOf:
2928+
- type: string
2929+
- type: array
2930+
items:
2931+
$ref: "#/components/schemas/V2StackEntity"
29122932
V2WalletInformation:
29132933
type: object
29142934
properties:

0 commit comments

Comments
 (0)