diff --git a/README.md b/README.md new file mode 100644 index 0000000..cd5bf94 --- /dev/null +++ b/README.md @@ -0,0 +1,258 @@ +# Protocol Documentation + + +## Table of Contents + +- [environments/environments_v1.proto](#environments_environments_v1-proto) + - [EnvironmentData](#environments-EnvironmentData) + - [EnvironmentFull](#environments-EnvironmentFull) + - [EnvironmentId](#environments-EnvironmentId) + + - [Provider](#environments-Provider) + + - [Environments](#environments-Environments) + +- [accounts/accounts_v1.proto](#accounts_accounts_v1-proto) + - [AccountData](#accounts-AccountData) + - [AccountFull](#accounts-AccountFull) + - [AccountFullWithKubeConfig](#accounts-AccountFullWithKubeConfig) + - [AccountId](#accounts-AccountId) + - [AccountPassword](#accounts-AccountPassword) + - [AccountWithPassword](#accounts-AccountWithPassword) + + - [Accounts](#accounts-Accounts) + +- [Scalar Value Types](#scalar-value-types) + + + + +
+ +## environments/environments_v1.proto +This file has messages for describing environments + + + + +### EnvironmentData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Environment name | +| provider | [Provider](#environments-Provider) | | Provide | + + + + + + + + +### EnvironmentFull + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [EnvironmentId](#environments-EnvironmentId) | | | +| data | [EnvironmentData](#environments-EnvironmentData) | | | + + + + + + + + +### EnvironmentId +Represents a environment UUID only + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | Contour ID: UUID | + + + + + + + + + + +### Provider + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| Hetzner | 0 | | + + + + + + + + + +### Environments +Service for handling environments + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [EnvironmentData](#environments-EnvironmentData) | [EnvironmentFull](#environments-EnvironmentFull) | | +| Update | [EnvironmentFull](#environments-EnvironmentFull) | [EnvironmentFull](#environments-EnvironmentFull) | | +| Delete | [EnvironmentFull](#environments-EnvironmentFull) | [.google.protobuf.Empty](#google-protobuf-Empty) | | +| Get | [EnvironmentId](#environments-EnvironmentId) | [EnvironmentFull](#environments-EnvironmentFull) | | +| List | [.google.protobuf.Empty](#google-protobuf-Empty) | [EnvironmentFull](#environments-EnvironmentFull) stream | | + + + + + + + + +## accounts/accounts_v1.proto +This file has messages for describing environments + + + + +### AccountData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Account name | +| email | [string](#string) | | Account email | + + + + + + + + +### AccountFull + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [AccountId](#accounts-AccountId) | | | +| data | [AccountData](#accounts-AccountData) | | | + + + + + + + + +### AccountFullWithKubeConfig + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [AccountId](#accounts-AccountId) | | | +| data | [AccountData](#accounts-AccountData) | | | +| kubeconfig | [string](#string) | | | + + + + + + + + +### AccountId +Represents a environment UUID only + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | Contour ID: UUID | + + + + + + + + +### AccountPassword + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| Password | [string](#string) | | | + + + + + + + + +### AccountWithPassword + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [AccountData](#accounts-AccountData) | | | +| AccountPassword | [AccountPassword](#accounts-AccountPassword) | | | + + + + + + + + + + + + + + +### Accounts +Service for handling environments + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| SignUp | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithKubeConfig](#accounts-AccountFullWithKubeConfig) | | +| SignIn | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithKubeConfig](#accounts-AccountFullWithKubeConfig) | | + + + + + +## 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) | +