apiv1

package

v1.12.0 Latest Latest Go to latest Published: Aug 22, 2024 License: MIT, Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/textileio/go-tableland

Links

Open Source Insights

Documentation ¶

Overview ¶

* Tableland Validator - OpenAPI 3.0 * * In Tableland, Validators are the execution unit/actors of the protocol. They have the following responsibilities: - Listen to onchain events to materialize Tableland-compliant SQL queries in a database engine (currently, SQLite by default). - Serve read-queries (e.g., SELECT * FROM foo_69_1) to the external world. - Serve state queries (e.g., list tables, get receipts, etc) to the external world. In the 1.0.0 release of the Tableland Validator API, we've switched to a design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3. The API includes the following endpoints: - `/health`: Returns OK if the validator considers itself healthy. - `/version`: Returns version information about the validator daemon. - `/query`: Returns the results of a SQL read query against the Tableland network. - `/receipt/{chainId}/{transactionHash}`: Returns the status of a given transaction receipt by hash. - `/tables/{chainId}/{tableId}`: Returns information about a single table, including schema information. * * API version: 1.1.0 * Contact: carson@textile.io * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

func GetTableById(w http.ResponseWriter, r *http.Request)
func Health(w http.ResponseWriter, r *http.Request)
func Index(w http.ResponseWriter, r *http.Request)
func Logger(inner http.Handler, name string) http.Handler
func NewRouter() *mux.Router
func QueryByStatement(w http.ResponseWriter, r *http.Request)
func QueryByStatementPost(w http.ResponseWriter, r *http.Request)
func ReceiptByTransactionHash(w http.ResponseWriter, r *http.Request)
func Version(w http.ResponseWriter, r *http.Request)
type Column
type OneOfQueryParamsItems
type OneOfTableAttributesValue
type Query
type Route
type Routes
type Schema
type Table
type TableAttributes
type TransactionReceipt
type VersionInfo

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetTableById ¶

func GetTableById(w http.ResponseWriter, r *http.Request)

func Health ¶

func Health(w http.ResponseWriter, r *http.Request)

func Index ¶

func Index(w http.ResponseWriter, r *http.Request)

func Logger ¶

func Logger(inner http.Handler, name string) http.Handler

func NewRouter ¶

func NewRouter() *mux.Router

func QueryByStatement ¶

func QueryByStatement(w http.ResponseWriter, r *http.Request)

func QueryByStatementPost ¶ added in v1.10.0

func QueryByStatementPost(w http.ResponseWriter, r *http.Request)

func ReceiptByTransactionHash ¶

func ReceiptByTransactionHash(w http.ResponseWriter, r *http.Request)

func Version ¶

func Version(w http.ResponseWriter, r *http.Request)

Types ¶

type Column ¶

type Column struct {
	Name string `json:"name,omitempty"`

	Type_ string `json:"type,omitempty"`

	Constraints []string `json:"constraints,omitempty"`
}

type OneOfQueryParamsItems ¶ added in v1.11.0

type OneOfQueryParamsItems struct {
}

type OneOfTableAttributesValue ¶

type OneOfTableAttributesValue struct {
}

type Query ¶ added in v1.10.0

type Query struct {
	// The SQL read query statement
	Statement string `json:"statement,omitempty"`
	// The values of query parameters
	Params []interface{} `json:"params,omitempty"`
	// 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 string `json:"format,omitempty"`
	// Whether to extract the JSON object from the single property of the surrounding JSON object.
	Extract bool `json:"extract,omitempty"`
	// Whether to unwrap the returned JSON objects from their surrounding array.
	Unwrap bool `json:"unwrap,omitempty"`
}

type Route ¶

type Route struct {
	Name        string
	Method      string
	Pattern     string
	HandlerFunc http.HandlerFunc
}

type Routes ¶

type Routes []Route

type Schema ¶

type Schema struct {
	Columns []Column `json:"columns,omitempty"`

	TableConstraints []string `json:"table_constraints,omitempty"`
}

type Table ¶

type Table struct {
	Name string `json:"name,omitempty"`

	ExternalUrl string `json:"external_url,omitempty"`

	AnimationUrl string `json:"animation_url,omitempty"`

	Image string `json:"image,omitempty"`

	Attributes []TableAttributes `json:"attributes,omitempty"`

	Schema *Schema `json:"schema,omitempty"`
}

type TableAttributes ¶

type TableAttributes struct {
	// The display type for marketplaces
	DisplayType string `json:"display_type,omitempty"`
	// The trait type for marketplaces
	TraitType string `json:"trait_type,omitempty"`
	// The value of the property
	Value interface{} `json:"value,omitempty"`
}

type TransactionReceipt ¶

type TransactionReceipt struct {
	// This field is deprecated
	TableId string `json:"table_id,omitempty"`

	TableIds []string `json:"table_ids,omitempty"`

	TransactionHash string `json:"transaction_hash,omitempty"`

	BlockNumber int64 `json:"block_number,omitempty"`

	ChainId int32 `json:"chain_id,omitempty"`

	Error_ string `json:"error,omitempty"`

	ErrorEventIdx int32 `json:"error_event_idx,omitempty"`
}

type VersionInfo ¶

type VersionInfo struct {
	Version int32 `json:"version,omitempty"`

	GitCommit string `json:"git_commit,omitempty"`

	GitBranch string `json:"git_branch,omitempty"`

	GitState string `json:"git_state,omitempty"`

	GitSummary string `json:"git_summary,omitempty"`

	BuildDate string `json:"build_date,omitempty"`

	BinaryVersion string `json:"binary_version,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL