Protocol Documentation

Table of Contents

• api/v1/api.proto

  • Group

  • PluginConfig

  • PluginConfig.ConfigEntry

  • PluginConfig.RequiresEntry

  • PluginConfigs

  • PluginID

  • VersionResponse

  • GatewayDAdminAPIService

• Scalar Value Types

Top

api/v1/api.proto

Group

Group is the object group to filter the global config by.

Field	Type	Label	Description
group_name	string	optional	GroupName is the name of the group.

PluginConfig

PluginConfig is the configuration of the plugin.

Field	Type	Label	Description
id	PluginID		ID is the identifier that uniquely identifies the plugin.
description	string		Description is the description of the plugin.
authors	string	repeated	Authors is the list of authors of the plugin.
license	string		License is the license of the plugin.
project_url	string		ProjectURL is the project URL of the plugin.
config	PluginConfig.ConfigEntry	repeated	Config is the internal and external configuration of the plugin.
hooks	int32	repeated	Hooks is the list of hooks the plugin attaches to.
requires	PluginConfig.RequiresEntry	repeated	Requires is the list of plugins the plugin depends on.
tags	string	repeated	Tags is the list of tags of the plugin.
categories	string	repeated	Categories is the list of categories of the plugin.

PluginConfig.ConfigEntry

Field	Type	Label	Description
key	string
value	string

PluginConfig.RequiresEntry

Field	Type	Label	Description
key	string
value	string

PluginConfigs

PluginConfigs is the list of plugin configurations.

Field	Type	Label	Description
configs	PluginConfig	repeated	Configs is the list of plugin configurations.

PluginID

PluginID is the identifier that uniquely identifies the plugin.

Field	Type	Label	Description
name	string		Name is the name of the plugin.
version	string		Version is the version of the plugin.
remote_url	string		RemoteURL is the remote URL of the plugin.
checksum	string		Checksum is the checksum of the plugin.

VersionResponse

VersionResponse is the response returned by the Version RPC.

Field	Type	Label	Description
version	string		Version is the version of the GatewayD.
version_info	string		VersionInfo is the detailed version info of the GatewayD.

GatewayDAdminAPIService

GatewayDAdminAPIService is the administration API of GatewayD.

Method Name	Request Type	Response Type	Description
Version	.google.protobuf.Empty	VersionResponse	Version returns the version of the GatewayD.
GetGlobalConfig	Group	.google.protobuf.Struct	GetGlobalConfig returns the global configuration of the GatewayD.
GetPluginConfig	.google.protobuf.Empty	.google.protobuf.Struct	GetPluginConfig returns the configuration of the specified plugin.
GetPlugins	.google.protobuf.Empty	PluginConfigs	GetPlugins returns the list of plugins installed on the GatewayD.
GetPools	.google.protobuf.Empty	.google.protobuf.Struct	GetPools returns the list of pools configured on the GatewayD.
GetProxies	.google.protobuf.Empty	.google.protobuf.Struct	GetProxies returns the list of proxies configured on the GatewayD.
GetServers	.google.protobuf.Empty	.google.protobuf.Struct	GetServers returns the list of servers configured on the GatewayD.

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)