Jump to

• Request
• Response

Check Commit Readiness

post

/console/admin/api/v2/channels/{channelName}/chaincodeDefinitions/checkCommitReadiness

Checks the commit readiness of a given chaincode definition in a channel.

Request

Supported Media Types

• application/json

Path Parameters

• channelName: string
  ID of the channel

Body ()

Details about the chaincode definition to check commit readiness

Root Schema : CheckCommitReadinessCCReq

Type: object

Show Source

• chaincodeInitRequired: boolean
• chaincodeName: string
• chaincodeSequence(optional): string
• chaincodeVersion: string
• dataCollectionConfig(optional): array dataCollectionConfig
• endorsementPolicy(optional): object endorsementPolicy

{
    "type":"object",
    "required":[
        "chaincodeName",
        "chaincodeVersion",
        "chaincodeInitRequired"
    ],
    "properties":{
        "chaincodeName":{
            "type":"string"
        },
        "chaincodeVersion":{
            "type":"string"
        },
        "chaincodeSequence":{
            "type":"string"
        },
        "chaincodeInitRequired":{
            "type":"boolean"
        },
        "endorsementPolicy":{
            "type":"object",
            "required":[
                "type",
                "policy"
            ],
            "properties":{
                "type":{
                    "type":"string",
                    "enum":[
                        "signature-policy",
                        "channel-config-policy"
                    ]
                },
                "policy":{
                    "type":"string"
                }
            }
        },
        "dataCollectionConfig":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "name",
                    "policy",
                    "requiredPeerCount",
                    "maxPeerCount",
                    "blockToLive"
                ],
                "properties":{
                    "name":{
                        "type":"string"
                    },
                    "policy":{
                        "type":"string"
                    },
                    "requiredPeerCount":{
                        "type":"number"
                    },
                    "maxPeerCount":{
                        "type":"number"
                    },
                    "blockToLive":{
                        "type":"number"
                    },
                    "memberOnlyRead":{
                        "type":"boolean"
                    },
                    "memberOnlyWrite":{
                        "type":"boolean"
                    },
                    "endorsementPolicy":{
                        "type":"object",
                        "properties":{
                            "signaturePolicy":{
                                "type":"string"
                            },
                            "channelConfigPolicy":{
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    },
    "example":{
        "chaincodeName":"myCC1",
        "chaincodeVersion":"v1",
        "chaincodeInitRequired":false,
        "endorsementPolicy":{
            "type":"signature-policy",
            "policy":"OR('org1.member')"
        },
        "dataCollectionConfig":[
            {
                "name":"test",
                "policy":"OR('org1.member')",
                "requiredPeerCount":1,
                "maxPeerCount":2,
                "blockToLive":10,
                "memberOnlyRead":true,
                "memberOnlyWrite":true,
                "endorsementPolicy":{
                    "signaturePolicy":"OutOf(1,'org1.member')"
                }
            }
        ]
    }
}

Example:

{
    "chaincodeName":"myCC1",
    "chaincodeVersion":"v1",
    "chaincodeInitRequired":false,
    "endorsementPolicy":{
        "type":"signature-policy",
        "policy":"OR('org1.member')"
    },
    "dataCollectionConfig":[
        {
            "name":"test",
            "policy":"OR('org1.member')",
            "requiredPeerCount":1,
            "maxPeerCount":2,
            "blockToLive":10,
            "memberOnlyRead":true,
            "memberOnlyWrite":true,
            "endorsementPolicy":{
                "signaturePolicy":"OutOf(1,'org1.member')"
            }
        }
    ]
}

Nested Schema : dataCollectionConfig

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "name",
            "policy",
            "requiredPeerCount",
            "maxPeerCount",
            "blockToLive"
        ],
        "properties":{
            "name":{
                "type":"string"
            },
            "policy":{
                "type":"string"
            },
            "requiredPeerCount":{
                "type":"number"
            },
            "maxPeerCount":{
                "type":"number"
            },
            "blockToLive":{
                "type":"number"
            },
            "memberOnlyRead":{
                "type":"boolean"
            },
            "memberOnlyWrite":{
                "type":"boolean"
            },
            "endorsementPolicy":{
                "type":"object",
                "properties":{
                    "signaturePolicy":{
                        "type":"string"
                    },
                    "channelConfigPolicy":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : endorsementPolicy

Type: object

Show Source

• policy: string
• type: string
  Allowed Values: [ "signature-policy", "channel-config-policy" ]

{
    "type":"object",
    "required":[
        "type",
        "policy"
    ],
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "signature-policy",
                "channel-config-policy"
            ]
        },
        "policy":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• blockToLive: number
• endorsementPolicy(optional): object endorsementPolicy
• maxPeerCount: number
• memberOnlyRead(optional): boolean
• memberOnlyWrite(optional): boolean
• name: string
• policy: string
• requiredPeerCount: number

{
    "type":"object",
    "required":[
        "name",
        "policy",
        "requiredPeerCount",
        "maxPeerCount",
        "blockToLive"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "policy":{
            "type":"string"
        },
        "requiredPeerCount":{
            "type":"number"
        },
        "maxPeerCount":{
            "type":"number"
        },
        "blockToLive":{
            "type":"number"
        },
        "memberOnlyRead":{
            "type":"boolean"
        },
        "memberOnlyWrite":{
            "type":"boolean"
        },
        "endorsementPolicy":{
            "type":"object",
            "properties":{
                "signaturePolicy":{
                    "type":"string"
                },
                "channelConfigPolicy":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : endorsementPolicy

Type: object

Show Source

• channelConfigPolicy(optional): string
• signaturePolicy(optional): string

{
    "type":"object",
    "properties":{
        "signaturePolicy":{
            "type":"string"
        },
        "channelConfigPolicy":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : checkCommitReadinessInfo

Type: object

Show Source

• approvals(optional): object approvals
• chaincodeSequence(optional): string

{
    "type":"object",
    "properties":{
        "chaincodeSequence":{
            "type":"string"
        },
        "approvals":{
            "type":"object"
        }
    }
}

Nested Schema : approvals

Type: object

400 Response

Invalid Arguments

Body ()

Root Schema : 400errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

Example:

{
    "respMesg":"invalid argument"
}

401 Response

Unauthorized

403 Response

Forbidden

500 Response

Internal Server Error

Body ()

Root Schema : 500errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Default Response

Unexpected error

Body ()

Root Schema : errorModel

Type: object

Show Source

• code: integer(int32)
• message: string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

Back to Top