Protobuf definitions for the softplayer API
Go to file
2024-09-23 13:15:16 +02:00
.woodpecker Update the go module path 2024-09-23 13:15:16 +02:00
proto Update the go module path 2024-09-23 13:15:16 +02:00
.protolint.yaml Init commit 2024-03-17 19:23:28 +01:00
Containerfile Init commit 2024-03-17 19:23:28 +01:00
Makefile Update some env related apis 2024-04-19 16:45:26 +02:00
README.md Add a reset password api 2024-05-21 09:08:52 +02:00

Protocol Documentation

Table of Contents

Top

environments/environments_v1.proto

This file has messages for describing environments

CreateOptions

Field Type Label Description
metadata EnvironmentMetadata
spec EnvironmentSpec
owner_id OwnerId
token Token

DeleteOptions

Field Type Label Description
id EnvironmentId
metadata EnvironmentMetadata
owner_id OwnerId
token Token

EnvironmentFull

Field Type Label Description
metadata EnvironmentMetadata
spec EnvironmentSpec
id EnvironmentId

EnvironmentId

Field Type Label Description
uuid string

EnvironmentMetadata

Field Type Label Description
name string A name of the environment
description string

EnvironmentSpec

Field Type Label Description
provider Provider Provide
kubernetes Kubernetes
server_type ServerType
server_location Location
disk_size int32

GetOptions

Field Type Label Description
id EnvironmentId
metadata EnvironmentMetadata
owner_id OwnerId
token Token

ListOptions

Field Type Label Description
metadata EnvironmentMetadata
search_string string
owner_id OwnerId
token Token

OwnerId

Field Type Label Description
uuid string UUID of a user that is creating an environemnt

Token

Field Type Label Description
token string Token that should be used to create an environment

UpdateOptions

Field Type Label Description
id EnvironmentId
metadata EnvironmentMetadata
spec EnvironmentSpec
owner_id OwnerId
token Token

Kubernetes

Name Number Description
KUBERNETES_UNSPECIFIED 0
KUBERNETES_K3S 1

Location

Name Number Description
LOCATION_UNSPECIFIED 0
LOCATION_HETZNER_NUREMBERG 1
LOCATION_HETZNER_FALKENSTEIN 2
LOCATION_HETZNER_HELSINKI 3
LOCATION_HETZNER_HILLSBORO 4
LOCATION_HETZNER_ASHBURN 5

Provider

Helpers and other messages

Name Number Description
PROVIDER_UNSPECIFIED 0
PROVIDER_HETZNER 1

ServerType

Name Number Description
SERVER_TYPE_UNSPECIFIED 0
SERVER_TYPE_STARTER 1
SERVER_TYPE_REGULAR 2
SERVER_TYPE_PLUS 3
SERVER_TYPE_PRO 4
SERVER_TYPE_CUSTOM 5

Environments

Service for handling environments

Method Name Request Type Response Type Description
Create CreateOptions EnvironmentFull
Update UpdateOptions EnvironmentFull
Delete DeleteOptions .google.protobuf.Empty
Get GetOptions EnvironmentFull
List ListOptions EnvironmentFull stream

Top

accounts/accounts_v1.proto

This file has messages for describing environments

AccountData

Field Type Label Description
name string Account name
email string Account email

AccountFull

Field Type Label Description
id AccountId
data AccountData

AccountFullWithToken

Field Type Label Description
id AccountId
data AccountData
token string

AccountId

Represents a environment UUID only

Field Type Label Description
id string Contour ID: UUID

AccountPassword

Field Type Label Description
password string

AccountWithPassword

Field Type Label Description
data AccountData
password AccountPassword

Accounts

Service for handling environments

Method Name Request Type Response Type Description
SignUp AccountWithPassword AccountFullWithToken
SignIn AccountWithPassword AccountFullWithToken
ResetPassword AccountData .google.protobuf.Empty

Top

applications/applications_v1.proto

This file has messages for describing applications

ApplicationFull

Field Type Label Description
metadata ApplicationMetadata
spec ApplicationSpec
id ApplicationId

ApplicationId

Field Type Label Description
uuid string

ApplicationMetadata

Field Type Label Description
name string
description string

ApplicationSpec

Field Type Label Description
application string
version string
environemnt_id string
config ApplicationSpec.ConfigEntry repeated
raw_config string

ApplicationSpec.ConfigEntry

Field Type Label Description
key string
value string

CreateOptions

Field Type Label Description
metadata ApplicationMetadata
spec ApplicationSpec
owner_id OwnerId
token Token

DeleteOptions

Field Type Label Description
id ApplicationId
metadata ApplicationMetadata
owner_id OwnerId
token Token

GetOptions

Field Type Label Description
id ApplicationId
metadata ApplicationMetadata
owner_id OwnerId
token Token

ListOptions

Field Type Label Description
metadata ApplicationMetadata
owner_id OwnerId
token Token

OwnerId

Field Type Label Description
uuid string UUID of a user that is creating an environemnt

Token

Field Type Label Description
token string Token that should be used to create an environment

UpdateOptions

Field Type Label Description
id ApplicationId
metadata ApplicationMetadata
spec ApplicationSpec
owner_id OwnerId
token Token

Applications

Service for handling applications

Method Name Request Type Response Type Description
Create CreateOptions ApplicationFull
Update UpdateOptions ApplicationFull
Delete DeleteOptions .google.protobuf.Empty
Get GetOptions ApplicationFull
List ListOptions ApplicationFull stream

Top

email/email_v1.proto

This file has messages for describing environments

ConfirmValidation

Field Type Label Description
user_id string
code int32

RequestValidation

Field Type Label Description
user_id string

EmailValidation

A service that should handle email validation

Method Name Request Type Response Type Description
SendRequest RequestValidation .google.protobuf.Empty
ValidateEmail ConfirmValidation .google.protobuf.Empty

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)