Update documentation from eb82a632ce
This commit is contained in:
parent
d1e097b1eb
commit
5c93bcc76b
664
README.md
664
README.md
@ -10,9 +10,33 @@
|
|||||||
- [AccountId](#accounts-AccountId)
|
- [AccountId](#accounts-AccountId)
|
||||||
- [AccountPassword](#accounts-AccountPassword)
|
- [AccountPassword](#accounts-AccountPassword)
|
||||||
- [AccountWithPassword](#accounts-AccountWithPassword)
|
- [AccountWithPassword](#accounts-AccountWithPassword)
|
||||||
|
- [AccountWithPasswordAndCode](#accounts-AccountWithPasswordAndCode)
|
||||||
|
- [EmailVerified](#accounts-EmailVerified)
|
||||||
|
|
||||||
- [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)
|
||||||
|
|
||||||
- [environments/environments_v1.proto](#environments_environments_v1-proto)
|
- [environments/environments_v1.proto](#environments_environments_v1-proto)
|
||||||
- [CreateOptions](#environments-CreateOptions)
|
- [CreateOptions](#environments-CreateOptions)
|
||||||
- [DeleteOptions](#environments-DeleteOptions)
|
- [DeleteOptions](#environments-DeleteOptions)
|
||||||
@ -33,28 +57,6 @@
|
|||||||
|
|
||||||
- [Environments](#environments-Environments)
|
- [Environments](#environments-Environments)
|
||||||
|
|
||||||
- [email/email_v1.proto](#email_email_v1-proto)
|
|
||||||
- [ConfirmValidation](#email-ConfirmValidation)
|
|
||||||
- [RequestValidation](#email-RequestValidation)
|
|
||||||
|
|
||||||
- [EmailValidation](#email-EmailValidation)
|
|
||||||
|
|
||||||
- [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)
|
|
||||||
|
|
||||||
- [Scalar Value Types](#scalar-value-types)
|
- [Scalar Value Types](#scalar-value-types)
|
||||||
|
|
||||||
|
|
||||||
@ -161,6 +163,38 @@ Represents a environment UUID only
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="accounts-AccountWithPasswordAndCode"></a>
|
||||||
|
|
||||||
|
### AccountWithPasswordAndCode
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| data | [AccountData](#accounts-AccountData) | | |
|
||||||
|
| password | [AccountPassword](#accounts-AccountPassword) | | |
|
||||||
|
| code | [string](#string) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="accounts-EmailVerified"></a>
|
||||||
|
|
||||||
|
### EmailVerified
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| verified | [bool](#bool) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -177,6 +211,299 @@ Service for handling environments
|
|||||||
| SignUp | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | |
|
| SignUp | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | |
|
||||||
| SignIn | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | |
|
| SignIn | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | |
|
||||||
| ResetPassword | [AccountData](#accounts-AccountData) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
|
| ResetPassword | [AccountData](#accounts-AccountData) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
|
||||||
|
| NewPassword | [AccountWithPasswordAndCode](#accounts-AccountWithPasswordAndCode) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
|
||||||
|
| IsEmailVerified | [AccountData](#accounts-AccountData) | [EmailVerified](#accounts-EmailVerified) | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<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) | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -456,297 +783,6 @@ Service for handling environments
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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) | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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 | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 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 |
|
||||||
@ -767,4 +803,4 @@ Service for handling applications
|
|||||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
|
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
|
||||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
|
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
|
||||||
|
|
||||||
Generated on Tue May 21 07:10:09 UTC 2024
|
Generated on Tue May 21 22:03:42 UTC 2024
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user