Update documentation

This commit is contained in:
Nikolai Rodionov 2024-05-06 07:38:43 +00:00
parent f306c1c6f9
commit 5e98513b38
1 changed files with 552 additions and 43 deletions

595
README.md
View File

@ -3,14 +3,27 @@
## Table of Contents
- [environments/environments_v1.proto](#environments_environments_v1-proto)
- [EnvironmentData](#environments-EnvironmentData)
- [EnvironmentFull](#environments-EnvironmentFull)
- [EnvironmentId](#environments-EnvironmentId)
- [applications/applications_v1.proto](#applications_applications_v1-proto)
- [ApplicationFull](#applications-ApplicationFull)
- [ApplicationId](#applications-ApplicationId)
- [ApplicationMetadata](#applications-ApplicationMetadata)
- [ApplicationSpec](#applications-ApplicationSpec)
- [ApplicationSpec.ConfigEntry](#applications-ApplicationSpec-ConfigEntry)
- [CreateOptions](#applications-CreateOptions)
- [DeleteOptions](#applications-DeleteOptions)
- [GetOptions](#applications-GetOptions)
- [ListOptions](#applications-ListOptions)
- [OwnerId](#applications-OwnerId)
- [Token](#applications-Token)
- [UpdateOptions](#applications-UpdateOptions)
- [Provider](#environments-Provider)
- [Applications](#applications-Applications)
- [Environments](#environments-Environments)
- [email/email_v1.proto](#email_email_v1-proto)
- [ConfirmValidation](#email-ConfirmValidation)
- [RequestValidation](#email-RequestValidation)
- [EmailValidation](#email-EmailValidation)
- [accounts/accounts_v1.proto](#accounts_accounts_v1-proto)
- [AccountData](#accounts-AccountData)
@ -22,58 +35,234 @@
- [Accounts](#accounts-Accounts)
- [environments/environments_v1.proto](#environments_environments_v1-proto)
- [CreateOptions](#environments-CreateOptions)
- [DeleteOptions](#environments-DeleteOptions)
- [EnvironmentFull](#environments-EnvironmentFull)
- [EnvironmentId](#environments-EnvironmentId)
- [EnvironmentMetadata](#environments-EnvironmentMetadata)
- [EnvironmentSpec](#environments-EnvironmentSpec)
- [GetOptions](#environments-GetOptions)
- [ListOptions](#environments-ListOptions)
- [OwnerId](#environments-OwnerId)
- [Token](#environments-Token)
- [UpdateOptions](#environments-UpdateOptions)
- [Kubernetes](#environments-Kubernetes)
- [Location](#environments-Location)
- [Provider](#environments-Provider)
- [ServerType](#environments-ServerType)
- [Environments](#environments-Environments)
- [Scalar Value Types](#scalar-value-types)
<a name="environments_environments_v1-proto"></a>
<a name="applications_applications_v1-proto"></a>
<p align="right"><a href="#top">Top</a></p>
## environments/environments_v1.proto
This file has messages for describing environments
## applications/applications_v1.proto
This file has messages for describing applications
<a name="environments-EnvironmentData"></a>
<a name="applications-ApplicationFull"></a>
### EnvironmentData
### ApplicationFull
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| name | [string](#string) | | Environment name |
| provider | [Provider](#environments-Provider) | | Provide |
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
| spec | [ApplicationSpec](#applications-ApplicationSpec) | | |
| id | [ApplicationId](#applications-ApplicationId) | | |
<a name="environments-EnvironmentFull"></a>
<a name="applications-ApplicationId"></a>
### EnvironmentFull
### ApplicationId
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [EnvironmentId](#environments-EnvironmentId) | | |
| data | [EnvironmentData](#environments-EnvironmentData) | | |
| uuid | [string](#string) | | |
<a name="environments-EnvironmentId"></a>
<a name="applications-ApplicationMetadata"></a>
### ApplicationMetadata
### EnvironmentId
Represents a environment UUID only
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [string](#string) | | Contour ID: UUID |
| name | [string](#string) | | |
| description | [string](#string) | | |
<a name="applications-ApplicationSpec"></a>
### ApplicationSpec
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| application | [string](#string) | | |
| version | [string](#string) | | |
| environemnt_id | [string](#string) | | |
| config | [ApplicationSpec.ConfigEntry](#applications-ApplicationSpec-ConfigEntry) | repeated | |
| raw_config | [string](#string) | | |
<a name="applications-ApplicationSpec-ConfigEntry"></a>
### ApplicationSpec.ConfigEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| key | [string](#string) | | |
| value | [string](#string) | | |
<a name="applications-CreateOptions"></a>
### CreateOptions
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
| spec | [ApplicationSpec](#applications-ApplicationSpec) | | |
| owner_id | [OwnerId](#applications-OwnerId) | | |
| token | [Token](#applications-Token) | | |
<a name="applications-DeleteOptions"></a>
### DeleteOptions
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [ApplicationId](#applications-ApplicationId) | | |
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
| owner_id | [OwnerId](#applications-OwnerId) | | |
| token | [Token](#applications-Token) | | |
<a name="applications-GetOptions"></a>
### GetOptions
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [ApplicationId](#applications-ApplicationId) | | |
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
| owner_id | [OwnerId](#applications-OwnerId) | | |
| token | [Token](#applications-Token) | | |
<a name="applications-ListOptions"></a>
### ListOptions
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
| owner_id | [OwnerId](#applications-OwnerId) | | |
| token | [Token](#applications-Token) | | |
<a name="applications-OwnerId"></a>
### OwnerId
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| uuid | [string](#string) | | UUID of a user that is creating an environemnt |
<a name="applications-Token"></a>
### Token
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| token | [string](#string) | | Token that should be used to create an environment |
<a name="applications-UpdateOptions"></a>
### UpdateOptions
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [ApplicationId](#applications-ApplicationId) | | |
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
| spec | [ApplicationSpec](#applications-ApplicationSpec) | | |
| owner_id | [OwnerId](#applications-OwnerId) | | |
| token | [Token](#applications-Token) | | |
@ -81,34 +270,81 @@ Represents a environment UUID only
<a name="environments-Provider"></a>
### Provider
| Name | Number | Description |
| ---- | ------ | ----------- |
| Hetzner | 0 | |
<a name="environments-Environments"></a>
<a name="applications-Applications"></a>
### Environments
Service for handling environments
### Applications
Service for handling applications
| 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 | |
| Create | [CreateOptions](#applications-CreateOptions) | [ApplicationFull](#applications-ApplicationFull) | |
| Update | [UpdateOptions](#applications-UpdateOptions) | [ApplicationFull](#applications-ApplicationFull) | |
| Delete | [DeleteOptions](#applications-DeleteOptions) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
| Get | [GetOptions](#applications-GetOptions) | [ApplicationFull](#applications-ApplicationFull) | |
| List | [ListOptions](#applications-ListOptions) | [ApplicationFull](#applications-ApplicationFull) stream | |
<a name="email_email_v1-proto"></a>
<p align="right"><a href="#top">Top</a></p>
## email/email_v1.proto
This file has messages for describing environments
<a name="email-ConfirmValidation"></a>
### ConfirmValidation
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| user_id | [string](#string) | | |
| code | [int32](#int32) | | |
<a name="email-RequestValidation"></a>
### RequestValidation
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| user_id | [string](#string) | | |
<a name="email-EmailValidation"></a>
### EmailValidation
A service that should handle email validation
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| SendRequest | [RequestValidation](#email-RequestValidation) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
| ValidateEmail | [ConfirmValidation](#email-ConfirmValidation) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
@ -163,7 +399,7 @@ This file has messages for describing environments
| ----- | ---- | ----- | ----------- |
| id | [AccountId](#accounts-AccountId) | | |
| data | [AccountData](#accounts-AccountData) | | |
| Token | [string](#string) | | |
| token | [string](#string) | | |
@ -193,7 +429,7 @@ Represents a environment UUID only
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Password | [string](#string) | | |
| password | [string](#string) | | |
@ -209,7 +445,7 @@ Represents a environment UUID only
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| data | [AccountData](#accounts-AccountData) | | |
| AccountPassword | [AccountPassword](#accounts-AccountPassword) | | |
| password | [AccountPassword](#accounts-AccountPassword) | | |
@ -236,6 +472,279 @@ Service for handling environments
<a name="environments_environments_v1-proto"></a>
<p align="right"><a href="#top">Top</a></p>
## environments/environments_v1.proto
This file has messages for describing environments
<a name="environments-CreateOptions"></a>
### CreateOptions
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| metadata | [EnvironmentMetadata](#environments-EnvironmentMetadata) | | |
| spec | [EnvironmentSpec](#environments-EnvironmentSpec) | | |
| owner_id | [OwnerId](#environments-OwnerId) | | |
| token | [Token](#environments-Token) | | |
<a name="environments-DeleteOptions"></a>
### DeleteOptions
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [EnvironmentId](#environments-EnvironmentId) | | |
| metadata | [EnvironmentMetadata](#environments-EnvironmentMetadata) | | |
| owner_id | [OwnerId](#environments-OwnerId) | | |
| token | [Token](#environments-Token) | | |
<a name="environments-EnvironmentFull"></a>
### EnvironmentFull
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| metadata | [EnvironmentMetadata](#environments-EnvironmentMetadata) | | |
| spec | [EnvironmentSpec](#environments-EnvironmentSpec) | | |
| id | [EnvironmentId](#environments-EnvironmentId) | | |
<a name="environments-EnvironmentId"></a>
### EnvironmentId
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| uuid | [string](#string) | | |
<a name="environments-EnvironmentMetadata"></a>
### EnvironmentMetadata
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| name | [string](#string) | | A name of the environment |
| description | [string](#string) | | |
<a name="environments-EnvironmentSpec"></a>
### EnvironmentSpec
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| provider | [Provider](#environments-Provider) | | Provide |
| kubernetes | [Kubernetes](#environments-Kubernetes) | | |
| server_type | [ServerType](#environments-ServerType) | | |
| server_location | [Location](#environments-Location) | | |
<a name="environments-GetOptions"></a>
### GetOptions
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [EnvironmentId](#environments-EnvironmentId) | | |
| metadata | [EnvironmentMetadata](#environments-EnvironmentMetadata) | | |
| owner_id | [OwnerId](#environments-OwnerId) | | |
| token | [Token](#environments-Token) | | |
<a name="environments-ListOptions"></a>
### ListOptions
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| metadata | [EnvironmentMetadata](#environments-EnvironmentMetadata) | | |
| search_string | [string](#string) | | |
| owner_id | [OwnerId](#environments-OwnerId) | | |
| token | [Token](#environments-Token) | | |
<a name="environments-OwnerId"></a>
### OwnerId
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| uuid | [string](#string) | | UUID of a user that is creating an environemnt |
<a name="environments-Token"></a>
### Token
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| token | [string](#string) | | Token that should be used to create an environment |
<a name="environments-UpdateOptions"></a>
### UpdateOptions
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [EnvironmentId](#environments-EnvironmentId) | | |
| metadata | [EnvironmentMetadata](#environments-EnvironmentMetadata) | | |
| spec | [EnvironmentSpec](#environments-EnvironmentSpec) | | |
| owner_id | [OwnerId](#environments-OwnerId) | | |
| token | [Token](#environments-Token) | | |
<a name="environments-Kubernetes"></a>
### Kubernetes
| Name | Number | Description |
| ---- | ------ | ----------- |
| KUBERNETES_UNSPECIFIED | 0 | |
| KUBERNETES_K3S | 1 | |
<a name="environments-Location"></a>
### 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 | |
<a name="environments-Provider"></a>
### Provider
Helpers and other messages
| Name | Number | Description |
| ---- | ------ | ----------- |
| PROVIDER_UNSPECIFIED | 0 | |
| PROVIDER_HETZNER | 1 | |
<a name="environments-ServerType"></a>
### 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 | |
<a name="environments-Environments"></a>
### Environments
Service for handling environments
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| Create | [CreateOptions](#environments-CreateOptions) | [EnvironmentFull](#environments-EnvironmentFull) | |
| Update | [UpdateOptions](#environments-UpdateOptions) | [EnvironmentFull](#environments-EnvironmentFull) | |
| Delete | [DeleteOptions](#environments-DeleteOptions) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
| Get | [GetOptions](#environments-GetOptions) | [EnvironmentFull](#environments-EnvironmentFull) | |
| List | [ListOptions](#environments-ListOptions) | [EnvironmentFull](#environments-EnvironmentFull) stream | |
## Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |