/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/health": { /** * Get health status * @description Returns OK if the validator considers itself healthy. */ get: operations["health"]; }; "/version": { /** * Get version information * @description Returns version information about the validator daemon. */ get: operations["version"]; }; "/query": { /** * Query the network * @description Returns the results of a SQL read query against the Tableland network */ get: operations["queryByStatement"]; /** * Query the network (POST) * @description Returns the results of a SQL read query against the Tableland network */ post: operations["queryByStatementPost"]; }; "/receipt/{chainId}/{transactionHash}": { /** * Get transaction status * @description Returns the status of a given transaction receipt by hash */ get: operations["receiptByTransactionHash"]; }; "/tables/{chainId}/{tableId}": { /** * Get table information * @description Returns information about a single table, including schema information */ get: operations["getTableById"]; }; } export type webhooks = Record; export interface components { schemas: { readonly Table: { /** @example healthbot_80001_1 */ readonly name?: string; /** @example https://testnets.tableland.network/api/v1/tables/80001/1 */ readonly external_url?: string; /** @example https://tables.testnets.tableland.xyz/80001/1.html */ readonly animation_url?: string; /** @example https://tables.testnets.tableland.xyz/80001/1.svg */ readonly image?: string; /** * @example { * "display_type": "date", * "trait_type": "created", * "value": 1657113720 * } */ readonly attributes?: readonly ({ /** @description The display type for marketplaces */ readonly display_type?: string; /** @description The trait type for marketplaces */ readonly trait_type?: string; /** @description The value of the property */ readonly value?: string | number | boolean | Record; })[]; readonly schema?: components["schemas"]["Schema"]; }; readonly TransactionReceipt: { /** * @deprecated * @description This field is deprecated * @example 1 */ readonly table_id?: string; /** * @example [ * "1", * "2" * ] */ readonly table_ids?: readonly (string)[]; /** @example 0x02f319429b8a7be1cbb492f0bfbf740d2472232a2edadde7df7c16c0b61aa78b */ readonly transaction_hash?: string; /** * Format: int64 * @example 27055540 */ readonly block_number?: number; /** * Format: int32 * @example 80001 */ readonly chain_id?: number; /** @example The query statement is invalid */ readonly error?: string; /** * Format: int32 * @example 1 */ readonly error_event_idx?: number; }; readonly Schema: { readonly columns?: readonly (components["schemas"]["Column"])[]; /** * @example [ * "PRIMARY KEY (id)" * ] */ readonly table_constraints?: readonly (string)[]; }; readonly Column: { /** @example id */ readonly name?: string; /** @example integer */ readonly type?: string; /** * @example [ * "NOT NULL", * "PRIMARY KEY", * "UNIQUE" * ] */ readonly constraints?: readonly (string)[]; }; readonly VersionInfo: { /** @example 79688910d4689dcc0991a0d8eb9d988200586d8f */ readonly git_commit?: string; /** @example foo/experimentalfeature */ readonly git_branch?: string; /** @example dirty */ readonly git_state?: string; /** @example v1.2.3_dirty */ readonly git_summary?: string; /** @example 2022-11-29T16:28:04Z */ readonly build_date?: string; /** @example v1.0.1 */ readonly binary_version?: string; }; readonly Query: { /** * @description The SQL read query statement * @example select * from healthbot_80001_1 */ readonly statement?: string; /** * @description The requested response format: * `objects` - Returns the query results as a JSON array of JSON objects. * `table` - Return the query results as a JSON object with columns and rows properties. * * @example objects */ readonly format?: string; /** * @description Whether to extract the JSON object from the single property of the surrounding JSON object. * @example false */ readonly extract?: boolean; /** * @description Whether to unwrap the returned JSON objects from their surrounding array. * @example false */ readonly unwrap?: boolean; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type external = Record; export interface operations { /** * Get health status * @description Returns OK if the validator considers itself healthy. */ health: { responses: { /** @description The validator is healthy. */ 200: never; }; }; /** * Get version information * @description Returns version information about the validator daemon. */ version: { responses: { /** @description successful operation */ 200: { content: { readonly "application/json": components["schemas"]["VersionInfo"]; }; }; }; }; /** * Query the network * @description Returns the results of a SQL read query against the Tableland network */ queryByStatement: { parameters: { query: { /** * @description The SQL read query statement * @example select * from healthbot_80001_1 */ statement: string; /** * @description The requested response format: * * `objects` - Returns the query results as a JSON array of JSON objects. * * `table` - Return the query results as a JSON object with columns and rows properties. */ format?: "objects" | "table"; /** @description Whether to extract the JSON object from the single property of the surrounding JSON object. */ extract?: boolean; /** @description Whether to unwrap the returned JSON objects from their surrounding array. */ unwrap?: boolean; }; }; responses: { /** @description Successful operation */ 200: { content: { readonly "application/json": Record; }; }; /** @description Invalid query/statement value */ 400: never; /** @description Row Not Found */ 404: never; /** @description Too Many Requests */ 429: never; }; }; /** * Query the network (POST) * @description Returns the results of a SQL read query against the Tableland network */ queryByStatementPost: { /** @description A JSON containing the statement and additional options */ readonly requestBody: { readonly content: { readonly "application/json": components["schemas"]["Query"]; }; }; responses: { /** @description Successful operation */ 200: { content: { readonly "application/json": Record; }; }; /** @description Invalid query/statement value */ 400: never; /** @description Row Not Found */ 404: never; /** @description Too Many Requests */ 429: never; }; }; /** * Get transaction status * @description Returns the status of a given transaction receipt by hash */ receiptByTransactionHash: { parameters: { path: { /** * @description The parent chain to target * @example 80001 */ chainId: number; /** * @description The transaction hash to request * @example 0x02f319429b8a7be1cbb492f0bfbf740d2472232a2edadde7df7c16c0b61aa78b */ transactionHash: string; }; }; responses: { /** @description successful operation */ 200: { content: { readonly "application/json": components["schemas"]["TransactionReceipt"]; }; }; /** @description Invalid chain identifier or transaction hash format */ 400: never; /** @description No transaction receipt found with the provided hash */ 404: never; /** @description Too Many Requests */ 429: never; }; }; /** * Get table information * @description Returns information about a single table, including schema information */ getTableById: { parameters: { path: { /** * @description The parent chain to target * @example 80001 */ chainId: number; /** * @description Table identifier * @example 1 */ tableId: string; }; }; responses: { /** @description successful operation */ 200: { content: { readonly "application/json": components["schemas"]["Table"]; }; }; /** @description Invalid chain or table identifier */ 400: never; /** @description Table Not Found */ 404: never; /** @description Too Many Requests */ 429: never; /** @description Internal Server Error */ 500: never; }; }; } //# sourceMappingURL=validator.d.ts.map