From 5c93bcc76bdeeaec3f7a93e3f433eb06d64c3233 Mon Sep 17 00:00:00 2001 From: Softplayer Bot Date: Tue, 21 May 2024 22:03:43 +0000 Subject: [PATCH] Update documentation from eb82a632ce2eb2cc06d6f23b577df423c2650afa --- README.md | 664 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 350 insertions(+), 314 deletions(-) diff --git a/README.md b/README.md index 098f9cc..cc55f06 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,33 @@ - [AccountId](#accounts-AccountId) - [AccountPassword](#accounts-AccountPassword) - [AccountWithPassword](#accounts-AccountWithPassword) + - [AccountWithPasswordAndCode](#accounts-AccountWithPasswordAndCode) + - [EmailVerified](#accounts-EmailVerified) - [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) - [CreateOptions](#environments-CreateOptions) - [DeleteOptions](#environments-DeleteOptions) @@ -33,28 +57,6 @@ - [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) @@ -160,6 +162,38 @@ Represents a environment UUID only + + + +### AccountWithPasswordAndCode + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [AccountData](#accounts-AccountData) | | | +| password | [AccountPassword](#accounts-AccountPassword) | | | +| code | [string](#string) | | | + + + + + + + + +### EmailVerified + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| verified | [bool](#bool) | | | + + + + + @@ -177,6 +211,299 @@ Service for handling environments | SignUp | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | | | SignIn | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | | | 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) | | + + + + + + +

Top

+ +## applications/applications_v1.proto +This file has messages for describing applications + + + + +### ApplicationFull + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | | +| spec | [ApplicationSpec](#applications-ApplicationSpec) | | | +| id | [ApplicationId](#applications-ApplicationId) | | | + + + + + + + + +### ApplicationId + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uuid | [string](#string) | | | + + + + + + + + +### ApplicationMetadata + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| description | [string](#string) | | | + + + + + + + + +### 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) | | | + + + + + + + + +### ApplicationSpec.ConfigEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + + + + + + +### CreateOptions + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | | +| spec | [ApplicationSpec](#applications-ApplicationSpec) | | | +| owner_id | [OwnerId](#applications-OwnerId) | | | +| token | [Token](#applications-Token) | | | + + + + + + + + +### DeleteOptions + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [ApplicationId](#applications-ApplicationId) | | | +| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | | +| owner_id | [OwnerId](#applications-OwnerId) | | | +| token | [Token](#applications-Token) | | | + + + + + + + + +### GetOptions + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [ApplicationId](#applications-ApplicationId) | | | +| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | | +| owner_id | [OwnerId](#applications-OwnerId) | | | +| token | [Token](#applications-Token) | | | + + + + + + + + +### ListOptions + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | | +| owner_id | [OwnerId](#applications-OwnerId) | | | +| token | [Token](#applications-Token) | | | + + + + + + + + +### OwnerId + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uuid | [string](#string) | | UUID of a user that is creating an environemnt | + + + + + + + + +### Token + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| token | [string](#string) | | Token that should be used to create an environment | + + + + + + + + +### 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) | | | + + + + + + + + + + + + + + +### 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 | | + + + + + + +

Top

+ +## email/email_v1.proto +This file has messages for describing environments + + + + +### ConfirmValidation + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| user_id | [string](#string) | | | +| code | [int32](#int32) | | | + + + + + + + + +### RequestValidation + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| user_id | [string](#string) | | | + + + + + + + + + + + + + + +### 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 - -

Top

- -## email/email_v1.proto -This file has messages for describing environments - - - - -### ConfirmValidation - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| user_id | [string](#string) | | | -| code | [int32](#int32) | | | - - - - - - - - -### RequestValidation - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| user_id | [string](#string) | | | - - - - - - - - - - - - - - -### 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) | | - - - - - - -

Top

- -## applications/applications_v1.proto -This file has messages for describing applications - - - - -### ApplicationFull - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | | -| spec | [ApplicationSpec](#applications-ApplicationSpec) | | | -| id | [ApplicationId](#applications-ApplicationId) | | | - - - - - - - - -### ApplicationId - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| uuid | [string](#string) | | | - - - - - - - - -### ApplicationMetadata - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | | -| description | [string](#string) | | | - - - - - - - - -### 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) | | | - - - - - - - - -### ApplicationSpec.ConfigEntry - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| key | [string](#string) | | | -| value | [string](#string) | | | - - - - - - - - -### CreateOptions - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | | -| spec | [ApplicationSpec](#applications-ApplicationSpec) | | | -| owner_id | [OwnerId](#applications-OwnerId) | | | -| token | [Token](#applications-Token) | | | - - - - - - - - -### DeleteOptions - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| id | [ApplicationId](#applications-ApplicationId) | | | -| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | | -| owner_id | [OwnerId](#applications-OwnerId) | | | -| token | [Token](#applications-Token) | | | - - - - - - - - -### GetOptions - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| id | [ApplicationId](#applications-ApplicationId) | | | -| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | | -| owner_id | [OwnerId](#applications-OwnerId) | | | -| token | [Token](#applications-Token) | | | - - - - - - - - -### ListOptions - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | | -| owner_id | [OwnerId](#applications-OwnerId) | | | -| token | [Token](#applications-Token) | | | - - - - - - - - -### OwnerId - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| uuid | [string](#string) | | UUID of a user that is creating an environemnt | - - - - - - - - -### Token - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| token | [string](#string) | | Token that should be used to create an environment | - - - - - - - - -### 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) | | | - - - - - - - - - - - - - - -### 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 | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | @@ -767,4 +803,4 @@ Service for handling applications | 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) | -Generated on Tue May 21 07:10:09 UTC 2024 +Generated on Tue May 21 22:03:42 UTC 2024