Protocol Documentation

Table of Contents

• repo.proto
  • CreateRepo
  • DestroyRepo
  • FileRead
  • ReadFile
  • ReadRepo
  • ReadRepos
  • RepoCreated
  • RepoDestroyed
  • RepoRead
  • RepoUpdated
  • ReposRead

  • UpdateRepo

  • AuthType

  • RepoType

  • Repo
• Scalar Value Types

Top

repo.proto

Repo is the service managing external repositories, such as helm.

CreateRepo

Field	Type	Label	Description
name	string		name of the repo
endpoint	string		repo endpoint
type	RepoType		type of repo
token	string		an auth token (if required for this repo)
username	string		a username to login with
password	string		a password to login with
helm_oci	bool		whether or not this is an OCI registry rather than a typical helm registry

DestroyRepo

Field	Type	Label	Description
uuid	string		unique id of the repo

FileRead

Field	Type	Label	Description
file	bytes		the contents of the file read

ReadFile

Field	Type	Label	Description
repo_id	string		unique id of the repo
branch	string		the branch to read the file from
file_path	string		relative path to the file

ReadRepo

Field	Type	Label	Description
uuid	string		unique id of the repo

ReadRepos

RepoCreated

RepoDestroyed

RepoRead

Field	Type	Label	Description
uuid	string		unique id of the repo
name	string		name of the repo
endpoint	string		repo endpoint
type	RepoType		type of repo
helm_oci	bool		whether or not this is an OCI registry rather than a typical helm registry
ready	bool		repo ready status, based on whether index.yaml can be fetched

RepoUpdated

ReposRead

Field	Type	Label	Description
repos	RepoRead	repeated	repos read

UpdateRepo

Field	Type	Label	Description
uuid	string		unique id of the repo
name	string		name of the repo
endpoint	string		repo endpoint
type	RepoType		type of repo
token	string		an auth token (if required for this repo)
username	string		a username to login with
password	string		a password to login with
helm_oci	bool		whether or not this is an OCI registry rather than a typical helm registry

AuthType

Name	Number	Description
CREDENTIALS	0
TOKEN	1

RepoType

Name	Number	Description
HELM_REPO	0
GIT_REPO	1

Repo

Method Name	Request Type	Response Type	Description
Create	CreateRepo	RepoCreated	adds a repo to the list of configurations
Update	UpdateRepo	RepoUpdated	edits an already existing repo
Destroy	DestroyRepo	RepoDestroyed	removes a repo from the list of configurations
Read	ReadRepo	RepoRead	reads out a repo
All	ReadRepos	ReposRead	gets all repos currently configured and their status
File	ReadFile	FileRead	gets the contents of a file from this git repository

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)