OpenAPI Reference

The Gate API is fully documented using OpenAPI 3.1.0 specification. This provides a machine-readable description of the API that can be used to generate client libraries, interactive documentation, and testing tools.

Type-Safe Client Libraries

We provide official, type-safe client libraries for multiple programming languages. These are the recommended way to interact with the Gate API as they provide compile-time type safety, better error handling, and are automatically kept in sync with API changes.

Official SDKs

Gate's API definitions are hosted on buf.build/minekube/gate, where you can directly pull client libraries using your preferred language's package manager:

TypeScript

via npm packages

Python

via pip packages

Go

via go modules

Rust

via crates

Kotlin

via Maven artifacts

Java

via Maven artifacts

OpenAPI Specification

If you still want to use the OpenAPI specification, you can find it below or in the GitHub repository here gate_service.openapi.yaml or as a raw text link gate_service.openapi.yaml.

gate_service.openapi.yaml

<!--@include: ./gen/openapi/minekube/gate/v1/gate_service.openapi.yaml -->