Jump to

• Request
• Response

Update Account Endpoint Template

patch

{baseUrl}/v1/register/{accountWithErc5982UupsContractAddress}

Updates the registered account and ERC-5982 UUPS contract endpoint template.

Request

Path Parameters

• accountWithErc5982UupsContractAddress(required): string
  Path parameter

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• deleteEndpoints(required): array deleteEndpoints
• upsertEndpoints(required): array upsertEndpoints

{
    "type":"object",
    "properties":{
        "upsertEndpoints":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "path":{
                        "type":"string",
                        "example":"initializeCBDCToken"
                    },
                    "httpMethod":{
                        "type":"string",
                        "example":"POST"
                    },
                    "contractMethod":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string",
                                "example":"initializeCBDCToken"
                            },
                            "signature":{
                                "type":"string",
                                "example":"initializeCBDCToken((string,string,string,string,string,string,string[],uint8,(uint256,bool),(bool)))"
                            }
                        },
                        "required":[
                            "name",
                            "signature"
                        ],
                        "additionalProperties":false
                    },
                    "args":{
                        "type":"array",
                        "items":{
                            "type":"string",
                            "example":"token"
                        }
                    }
                },
                "required":[
                    "path",
                    "httpMethod",
                    "contractMethod",
                    "args"
                ],
                "additionalProperties":false
            }
        },
        "deleteEndpoints":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "path":{
                        "type":"string",
                        "example":"oldEndpoint"
                    },
                    "httpMethod":{
                        "type":"string",
                        "example":"POST"
                    }
                },
                "required":[
                    "path",
                    "httpMethod"
                ],
                "additionalProperties":false
            }
        }
    },
    "required":[
        "upsertEndpoints",
        "deleteEndpoints"
    ],
    "additionalProperties":false
}

Nested Schema : deleteEndpoints

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "path":{
                "type":"string",
                "example":"oldEndpoint"
            },
            "httpMethod":{
                "type":"string",
                "example":"POST"
            }
        },
        "required":[
            "path",
            "httpMethod"
        ],
        "additionalProperties":false
    }
}

Nested Schema : upsertEndpoints

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "path":{
                "type":"string",
                "example":"initializeCBDCToken"
            },
            "httpMethod":{
                "type":"string",
                "example":"POST"
            },
            "contractMethod":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "example":"initializeCBDCToken"
                    },
                    "signature":{
                        "type":"string",
                        "example":"initializeCBDCToken((string,string,string,string,string,string,string[],uint8,(uint256,bool),(bool)))"
                    }
                },
                "required":[
                    "name",
                    "signature"
                ],
                "additionalProperties":false
            },
            "args":{
                "type":"array",
                "items":{
                    "type":"string",
                    "example":"token"
                }
            }
        },
        "required":[
            "path",
            "httpMethod",
            "contractMethod",
            "args"
        ],
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

• httpMethod(required): string
  Example: POST
• path(required): string
  Example: oldEndpoint

{
    "type":"object",
    "properties":{
        "path":{
            "type":"string",
            "example":"oldEndpoint"
        },
        "httpMethod":{
            "type":"string",
            "example":"POST"
        }
    },
    "required":[
        "path",
        "httpMethod"
    ],
    "additionalProperties":false
}

Nested Schema : items

Type: object

Show Source

• args(required): array args
• contractMethod(required): object contractMethod
• httpMethod(required): string
  Example: POST
• path(required): string
  Example: initializeCBDCToken

{
    "type":"object",
    "properties":{
        "path":{
            "type":"string",
            "example":"initializeCBDCToken"
        },
        "httpMethod":{
            "type":"string",
            "example":"POST"
        },
        "contractMethod":{
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "example":"initializeCBDCToken"
                },
                "signature":{
                    "type":"string",
                    "example":"initializeCBDCToken((string,string,string,string,string,string,string[],uint8,(uint256,bool),(bool)))"
                }
            },
            "required":[
                "name",
                "signature"
            ],
            "additionalProperties":false
        },
        "args":{
            "type":"array",
            "items":{
                "type":"string",
                "example":"token"
            }
        }
    },
    "required":[
        "path",
        "httpMethod",
        "contractMethod",
        "args"
    ],
    "additionalProperties":false
}

Nested Schema : args

Type: array

Show Source

• Array of: string
  Example: token

{
    "type":"array",
    "items":{
        "type":"string",
        "example":"token"
    }
}

Nested Schema : contractMethod

Type: object

Show Source

• name(required): string
  Example: initializeCBDCToken
• signature(required): string
  Example: initializeCBDCToken((string,string,string,string,string,string,string[],uint8,(uint256,bool),(bool)))

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"initializeCBDCToken"
        },
        "signature":{
            "type":"string",
            "example":"initializeCBDCToken((string,string,string,string,string,string,string[],uint8,(uint256,bool),(bool)))"
        }
    },
    "required":[
        "name",
        "signature"
    ],
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Contract template updated successfully.

Body ()

Root Schema : Register_SuccessResponse

Type: object

Show Source

• schema(required): object RegisteredSchema
• status(required): string

{
    "type":"object",
    "required":[
        "status",
        "schema"
    ],
    "properties":{
        "status":{
            "type":"string",
            "const":"success"
        },
        "schema":{
            "$ref":"#/components/schemas/RegisteredSchema"
        }
    }
}

Nested Schema : RegisteredSchema

Type: object

Show Source

• combinedApis(required): array combinedApis
• contractAddress(required): string
  Pattern: ^0x[a-fA-F0-9]{40}$
• endpoints(required): array endpoints
• readConfigs(required): object readConfigs
  Additional Properties Allowed: true
• writeConfigs(required): object writeConfigs
  Additional Properties Allowed: true

{
    "type":"object",
    "required":[
        "contractAddress",
        "writeConfigs",
        "readConfigs",
        "endpoints",
        "combinedApis"
    ],
    "properties":{
        "contractAddress":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{40}$"
        },
        "writeConfigs":{
            "type":"object",
            "additionalProperties":true
        },
        "readConfigs":{
            "type":"object",
            "additionalProperties":true
        },
        "endpoints":{
            "type":"array",
            "items":{
                "type":"object",
                "additionalProperties":true
            }
        },
        "combinedApis":{
            "type":"array",
            "items":{
                "type":"object",
                "additionalProperties":true
            }
        }
    }
}

Nested Schema : combinedApis

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: true

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":true
    }
}

Nested Schema : endpoints

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: true

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":true
    }
}

Nested Schema : readConfigs

Type: object

Additional Properties Allowed: true

Nested Schema : writeConfigs

Type: object

Additional Properties Allowed: true

Nested Schema : items

Type: object

Additional Properties Allowed: true

Nested Schema : items

Type: object

Additional Properties Allowed: true

400 Response

The wrapper rejected the request before it could complete a downstream call.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

401 Response

A valid Bearer token with a supported user claim is required.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

404 Response

The requested registered contract schema was not found.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

415 Response

Content-Type must be application/json.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

502 Response

The wrapper could not complete the downstream call.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

Back to Top