From ecde3a0f790c85adedb43f201a391d9d9a14f4de Mon Sep 17 00:00:00 2001 From: Softplayer Bot Date: Mon, 6 May 2024 19:42:46 +0000 Subject: [PATCH] Update documentation from f2baff2f931c2e839c549f08a7ba8e4d0a3ec578 --- README.md | 395 +++++++++++++++++++++++++++--------------------------- 1 file changed, 198 insertions(+), 197 deletions(-) diff --git a/README.md b/README.md index 71872a4..b69bbd6 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,6 @@ ## Table of Contents -- [accounts/accounts_v1.proto](#accounts_accounts_v1-proto) - - [AccountData](#accounts-AccountData) - - [AccountFull](#accounts-AccountFull) - - [AccountFullWithToken](#accounts-AccountFullWithToken) - - [AccountId](#accounts-AccountId) - - [AccountPassword](#accounts-AccountPassword) - - [AccountWithPassword](#accounts-AccountWithPassword) - - - [Accounts](#accounts-Accounts) - - [applications/applications_v1.proto](#applications_applications_v1-proto) - [ApplicationFull](#applications-ApplicationFull) - [ApplicationId](#applications-ApplicationId) @@ -29,6 +19,22 @@ - [Applications](#applications-Applications) +- [accounts/accounts_v1.proto](#accounts_accounts_v1-proto) + - [AccountData](#accounts-AccountData) + - [AccountFull](#accounts-AccountFull) + - [AccountFullWithToken](#accounts-AccountFullWithToken) + - [AccountId](#accounts-AccountId) + - [AccountPassword](#accounts-AccountPassword) + - [AccountWithPassword](#accounts-AccountWithPassword) + + - [Accounts](#accounts-Accounts) + +- [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) @@ -49,138 +55,10 @@ - [Environments](#environments-Environments) -- [email/email_v1.proto](#email_email_v1-proto) - - [ConfirmValidation](#email-ConfirmValidation) - - [RequestValidation](#email-RequestValidation) - - - [EmailValidation](#email-EmailValidation) - - [Scalar Value Types](#scalar-value-types) - -

Top

- -## 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) | | | - - - - - - - - -### AccountFullWithToken - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| id | [AccountId](#accounts-AccountId) | | | -| data | [AccountData](#accounts-AccountData) | | | -| token | [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) | | | -| password | [AccountPassword](#accounts-AccountPassword) | | | - - - - - - - - - - - - - - -### Accounts -Service for handling environments - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| SignUp | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | | -| SignIn | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | | - - - - -

Top

@@ -414,6 +292,186 @@ Service for handling applications + +

Top

+ +## 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) | | | + + + + + + + + +### AccountFullWithToken + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [AccountId](#accounts-AccountId) | | | +| data | [AccountData](#accounts-AccountData) | | | +| token | [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) | | | +| password | [AccountPassword](#accounts-AccountPassword) | | | + + + + + + + + + + + + + + +### Accounts +Service for handling environments + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| SignUp | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | | +| SignIn | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | | + + + + + + +

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

@@ -517,6 +575,7 @@ This file has messages for describing environments | kubernetes | [Kubernetes](#environments-Kubernetes) | | | | server_type | [ServerType](#environments-ServerType) | | | | server_location | [Location](#environments-Location) | | | +| disk_size | [int32](#int32) | | | @@ -687,64 +746,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) | | - - - - - ## Scalar Value Types | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | @@ -765,4 +766,4 @@ A service that should handle email validation | 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 Mon May 6 07:44:41 UTC 2024 +Generated on Mon May 6 19:42:45 UTC 2024