Try another docs-gen command
This commit is contained in:
parent
2a92b9987c
commit
075a72077f
@ -18,7 +18,7 @@ steps:
|
|||||||
- echo $GIT_KNOWN_HOSTS > ~/.ssh/known_hosts
|
- echo $GIT_KNOWN_HOSTS > ~/.ssh/known_hosts
|
||||||
- cat ~/.ssh/id_ed25519
|
- cat ~/.ssh/id_ed25519
|
||||||
- chmod 0600 ~/.ssh/id_ed25519
|
- chmod 0600 ~/.ssh/id_ed25519
|
||||||
- protoc --proto_path=./proto --doc_out=. --doc_opt=markdown,readme.md $(find ./proto -type f -iname "*.proto")
|
- protoc --proto_path=./proto --doc_out=. --doc_opt=markdown,README.md $(find ./proto -type f -iname "*.proto")
|
||||||
- eval `ssh-agent`
|
- eval `ssh-agent`
|
||||||
- ssh-add ~/.ssh/id_ed25519
|
- ssh-add ~/.ssh/id_ed25519
|
||||||
- git config --global user.email "allanger@badhouseplants.net"
|
- git config --global user.email "allanger@badhouseplants.net"
|
||||||
|
543
README.md
543
README.md
@ -4,11 +4,22 @@
|
|||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [environments/environments_v1.proto](#environments_environments_v1-proto)
|
- [environments/environments_v1.proto](#environments_environments_v1-proto)
|
||||||
- [EnvironmentData](#environments-EnvironmentData)
|
- [CreateOptions](#environments-CreateOptions)
|
||||||
|
- [DeleteOptions](#environments-DeleteOptions)
|
||||||
- [EnvironmentFull](#environments-EnvironmentFull)
|
- [EnvironmentFull](#environments-EnvironmentFull)
|
||||||
- [EnvironmentId](#environments-EnvironmentId)
|
- [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)
|
- [Provider](#environments-Provider)
|
||||||
|
- [ServerType](#environments-ServerType)
|
||||||
|
|
||||||
- [Environments](#environments-Environments)
|
- [Environments](#environments-Environments)
|
||||||
|
|
||||||
@ -22,6 +33,28 @@
|
|||||||
|
|
||||||
- [Accounts](#accounts-Accounts)
|
- [Accounts](#accounts-Accounts)
|
||||||
|
|
||||||
|
- [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)
|
||||||
|
|
||||||
|
- [Applications](#applications-Applications)
|
||||||
|
|
||||||
|
- [email/email_v1.proto](#email_email_v1-proto)
|
||||||
|
- [ConfirmValidation](#email-ConfirmValidation)
|
||||||
|
- [RequestValidation](#email-RequestValidation)
|
||||||
|
|
||||||
|
- [EmailValidation](#email-EmailValidation)
|
||||||
|
|
||||||
- [Scalar Value Types](#scalar-value-types)
|
- [Scalar Value Types](#scalar-value-types)
|
||||||
|
|
||||||
|
|
||||||
@ -33,16 +66,36 @@
|
|||||||
This file has messages for describing environments
|
This file has messages for describing environments
|
||||||
|
|
||||||
|
|
||||||
<a name="environments-EnvironmentData"></a>
|
<a name="environments-CreateOptions"></a>
|
||||||
|
|
||||||
### EnvironmentData
|
### CreateOptions
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
| Field | Type | Label | Description |
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| name | [string](#string) | | Environment name |
|
| metadata | [EnvironmentMetadata](#environments-EnvironmentMetadata) | | |
|
||||||
| provider | [Provider](#environments-Provider) | | Provide |
|
| 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) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -57,8 +110,9 @@ This file has messages for describing environments
|
|||||||
|
|
||||||
| Field | Type | Label | Description |
|
| Field | Type | Label | Description |
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| metadata | [EnvironmentMetadata](#environments-EnvironmentMetadata) | | |
|
||||||
|
| spec | [EnvironmentSpec](#environments-EnvironmentSpec) | | |
|
||||||
| id | [EnvironmentId](#environments-EnvironmentId) | | |
|
| id | [EnvironmentId](#environments-EnvironmentId) | | |
|
||||||
| data | [EnvironmentData](#environments-EnvironmentData) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -68,28 +122,192 @@ This file has messages for describing environments
|
|||||||
<a name="environments-EnvironmentId"></a>
|
<a name="environments-EnvironmentId"></a>
|
||||||
|
|
||||||
### EnvironmentId
|
### EnvironmentId
|
||||||
Represents a environment UUID only
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
| Field | Type | Label | Description |
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| id | [string](#string) | | Contour ID: UUID |
|
| 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>
|
<a name="environments-Provider"></a>
|
||||||
|
|
||||||
### Provider
|
### Provider
|
||||||
|
Helpers and other messages
|
||||||
|
|
||||||
|
| Name | Number | Description |
|
||||||
|
| ---- | ------ | ----------- |
|
||||||
|
| PROVIDER_UNSPECIFIED | 0 | |
|
||||||
|
| PROVIDER_HETZNER | 1 | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="environments-ServerType"></a>
|
||||||
|
|
||||||
|
### ServerType
|
||||||
|
|
||||||
|
|
||||||
| Name | Number | Description |
|
| Name | Number | Description |
|
||||||
| ---- | ------ | ----------- |
|
| ---- | ------ | ----------- |
|
||||||
| Hetzner | 0 | |
|
| SERVER_TYPE_UNSPECIFIED | 0 | |
|
||||||
|
| SERVER_TYPE_STARTER | 1 | |
|
||||||
|
| SERVER_TYPE_REGULAR | 2 | |
|
||||||
|
| SERVER_TYPE_PLUS | 3 | |
|
||||||
|
| SERVER_TYPE_PRO | 4 | |
|
||||||
|
| SERVER_TYPE_CUSTOM | 5 | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -104,11 +322,11 @@ Service for handling environments
|
|||||||
|
|
||||||
| Method Name | Request Type | Response Type | Description |
|
| Method Name | Request Type | Response Type | Description |
|
||||||
| ----------- | ------------ | ------------- | ------------|
|
| ----------- | ------------ | ------------- | ------------|
|
||||||
| Create | [EnvironmentData](#environments-EnvironmentData) | [EnvironmentFull](#environments-EnvironmentFull) | |
|
| Create | [CreateOptions](#environments-CreateOptions) | [EnvironmentFull](#environments-EnvironmentFull) | |
|
||||||
| Update | [EnvironmentFull](#environments-EnvironmentFull) | [EnvironmentFull](#environments-EnvironmentFull) | |
|
| Update | [UpdateOptions](#environments-UpdateOptions) | [EnvironmentFull](#environments-EnvironmentFull) | |
|
||||||
| Delete | [EnvironmentFull](#environments-EnvironmentFull) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
|
| Delete | [DeleteOptions](#environments-DeleteOptions) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
|
||||||
| Get | [EnvironmentId](#environments-EnvironmentId) | [EnvironmentFull](#environments-EnvironmentFull) | |
|
| Get | [GetOptions](#environments-GetOptions) | [EnvironmentFull](#environments-EnvironmentFull) | |
|
||||||
| List | [.google.protobuf.Empty](#google-protobuf-Empty) | [EnvironmentFull](#environments-EnvironmentFull) stream | |
|
| List | [ListOptions](#environments-ListOptions) | [EnvironmentFull](#environments-EnvironmentFull) stream | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -163,7 +381,7 @@ This file has messages for describing environments
|
|||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| id | [AccountId](#accounts-AccountId) | | |
|
| id | [AccountId](#accounts-AccountId) | | |
|
||||||
| data | [AccountData](#accounts-AccountData) | | |
|
| data | [AccountData](#accounts-AccountData) | | |
|
||||||
| Token | [string](#string) | | |
|
| token | [string](#string) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -193,7 +411,7 @@ Represents a environment UUID only
|
|||||||
|
|
||||||
| Field | Type | Label | Description |
|
| Field | Type | Label | Description |
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| Password | [string](#string) | | |
|
| password | [string](#string) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -209,7 +427,7 @@ Represents a environment UUID only
|
|||||||
| Field | Type | Label | Description |
|
| Field | Type | Label | Description |
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| data | [AccountData](#accounts-AccountData) | | |
|
| data | [AccountData](#accounts-AccountData) | | |
|
||||||
| AccountPassword | [AccountPassword](#accounts-AccountPassword) | | |
|
| password | [AccountPassword](#accounts-AccountPassword) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -236,6 +454,297 @@ Service for handling environments
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications_applications_v1-proto"></a>
|
||||||
|
<p align="right"><a href="#top">Top</a></p>
|
||||||
|
|
||||||
|
## applications/applications_v1.proto
|
||||||
|
This file has messages for describing applications
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-ApplicationFull"></a>
|
||||||
|
|
||||||
|
### ApplicationFull
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
|
||||||
|
| spec | [ApplicationSpec](#applications-ApplicationSpec) | | |
|
||||||
|
| id | [ApplicationId](#applications-ApplicationId) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-ApplicationId"></a>
|
||||||
|
|
||||||
|
### ApplicationId
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| uuid | [string](#string) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-ApplicationMetadata"></a>
|
||||||
|
|
||||||
|
### ApplicationMetadata
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| 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) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-Applications"></a>
|
||||||
|
|
||||||
|
### Applications
|
||||||
|
Service for handling applications
|
||||||
|
|
||||||
|
| Method Name | Request Type | Response Type | Description |
|
||||||
|
| ----------- | ------------ | ------------- | ------------|
|
||||||
|
| 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) | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Scalar Value Types
|
## Scalar Value Types
|
||||||
|
|
||||||
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|
||||||
|
Loading…
Reference in New Issue
Block a user