Jump to

• Request
• Response

Get Registered Endpoints

get

{baseUrl}/v1/register

Retrieves the registered endpoint schemas.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Security

• OAuth2Password: oauth2
  Type: oauth2

Back to Top

Response

Supported Media Types

• application/json

200 Response

Registered contract templates retrieved successfully.

Body ()

Root Schema : Register_ListSuccessResponse

Type: object

Show Source

• schemas(required): array schemas
• status(required): string

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

Nested Schema : schemas

Type: array

Show Source

• Array of: object RegisteredSchema

{
    "type":"array",
    "items":{
        "$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

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",
    "required":[
        "status",
        "error"
    ],
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    }
}

Back to Top