Skip to content

Commit 9d6e94f

Browse files
docs: added examples for smart contract API's (#1260)
1 parent 316ab63 commit 9d6e94f

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/openapi.yaml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -924,7 +924,7 @@ paths:
924924
in: path
925925
description: Contract identifier formatted as `<contract_address>.<contract_name>`
926926
required: true
927-
example: SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.staking-helper
927+
example: SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C.satoshibles
928928
schema:
929929
type: string
930930
- name: unanchored
@@ -985,6 +985,7 @@ paths:
985985
in: path
986986
description: Contract identifier formatted as `<contract_address>.<contract_name>`
987987
required: true
988+
example: SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C.satoshibles
988989
schema:
989990
type: string
990991
- name: limit
@@ -1039,12 +1040,14 @@ paths:
10391040
in: path
10401041
required: true
10411042
description: Stacks address
1043+
example: SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C
10421044
schema:
10431045
type: string
10441046
- name: contract_name
10451047
in: path
10461048
required: true
10471049
description: Contract name
1050+
example: satoshibles
10481051
schema:
10491052
type: string
10501053
- name: tip
@@ -1081,12 +1084,14 @@ paths:
10811084
in: path
10821085
required: true
10831086
description: Stacks address
1087+
example: SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C
10841088
schema:
10851089
type: string
10861090
- name: contract_name
10871091
in: path
10881092
required: true
10891093
description: Contract name
1094+
example: satoshibles
10901095
schema:
10911096
type: string
10921097
- name: map_name
@@ -1135,12 +1140,14 @@ paths:
11351140
in: path
11361141
required: true
11371142
description: Stacks address
1143+
example: SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C
11381144
schema:
11391145
type: string
11401146
- name: contract_name
11411147
in: path
11421148
required: true
11431149
description: Contract name
1150+
example: satoshibles
11441151
schema:
11451152
type: string
11461153
- name: proof
@@ -1184,12 +1191,14 @@ paths:
11841191
in: path
11851192
required: true
11861193
description: Stacks address
1194+
example: SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C
11871195
schema:
11881196
type: string
11891197
- name: contract_name
11901198
in: path
11911199
required: true
11921200
description: Contract name
1201+
example: satoshibles
11931202
schema:
11941203
type: string
11951204
- name: function_name

0 commit comments

Comments
 (0)