-
Notifications
You must be signed in to change notification settings - Fork 11
docs: add tx types to transactions_spec.yaml #2119
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
@@ -1,4 +1,30 @@ | |||
schemas: | |||
ChannelId: | |||
type: string | |||
example: ch_2VfzXmCRZepB3ichPf3WTt2uf8zMqsyY3cZWg8k1vt3xcu8L8V |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
example: ch_2VfzXmCRZepB3ichPf3WTt2uf8zMqsyY3cZWg8k1vt3xcu8L8V | |
pattern: ^ch_\w{38,50}$ | |
example: ch_2VfzXmCRZepB3ichPf3WTt2uf8zMqsyY3cZWg8k1vt3xcu8L8V |
so SDK can know that it is ch_
-prefixed
docs/swagger_v3/channels.spec.yaml
Outdated
type: object | ||
required: | ||
- responder_id | ||
- initiator_id | ||
- round | ||
properties: | ||
initiator_id: | ||
$ref: '#/components/schemas/AccountAddress' | ||
responder_id: | ||
$ref: '#/components/schemas/AccountAddress' | ||
round: | ||
type: integer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
type: object | |
required: | |
- responder_id | |
- initiator_id | |
- round | |
properties: | |
initiator_id: | |
$ref: '#/components/schemas/AccountAddress' | |
responder_id: | |
$ref: '#/components/schemas/AccountAddress' | |
round: | |
type: integer | |
allOf: | |
- '#/components/schemas/ChannelResponderInitiator' | |
- type: object | |
required: | |
- round | |
properties: | |
round: | |
type: integer |
properties: | ||
aexn_type: | ||
type: string | ||
example: aex9 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
example: aex9 | |
example: aex9 | |
enum: | |
- aex9 |
docs/swagger_v3/contracts.spec.yaml
Outdated
type: array | ||
items: | ||
type: object | ||
properties: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
properties: | |
required: | |
- type | |
- value | |
properties: |
docs/swagger_v3/contracts.spec.yaml
Outdated
type: array | ||
items: | ||
type: object | ||
properties: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
properties: | |
required: | |
- address | |
- data | |
- topics | |
properties: |
- args | ||
- auth_fun_name | ||
- contract_id | ||
- gas_used | ||
- return_type |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the only auth_fun_name
is not defined in MdwContractCreateExtras
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you elaborate this, I don't think I understood you
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I meant to reuse some of the contract definitions, but maybe it isn't worth it 🤷♀️
gas_used: | ||
type: integer | ||
return_type: | ||
type: string |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
type: string | |
type: string | |
enum: | |
- ok |
gas_used: | ||
type: integer | ||
return_type: | ||
type: string |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
type: string | |
type: string | |
enum: | |
- ok |
- gas_used | ||
- return_type |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also a duplicate definition
required: | ||
- type | ||
type: object |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
required: | |
- type | |
type: object |
type
already marked as required at line 7 🤔
- aexn_type | ||
- gas_used | ||
- return_type | ||
- ttl |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't mess with ttl, just preserve the node behaviour and types
- "topic2" | ||
result: | ||
type: string | ||
example: ok |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't it also an ok | revert | error enum?
- args | ||
- auth_fun_name | ||
- contract_id | ||
- gas_used | ||
- return_type |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I meant to reuse some of the contract definitions, but maybe it isn't worth it 🤷♀️
enum: | ||
- ok | ||
- error | ||
- revert |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
contract create can't be reverted as I know
Added the missing fields in the swagger for transactions and added the ttl field to the transactions as in the docs
resolves: #2115