diff --git a/README.md b/README.md index 0cd2791..71872a4 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,16 @@ ## 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) @@ -19,22 +29,6 @@ - [Applications](#applications-Applications) -- [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) - - [AccountFull](#accounts-AccountFull) - - [AccountFullWithToken](#accounts-AccountFullWithToken) - - [AccountId](#accounts-AccountId) - - [AccountPassword](#accounts-AccountPassword) - - [AccountWithPassword](#accounts-AccountWithPassword) - - - [Accounts](#accounts-Accounts) - - [environments/environments_v1.proto](#environments_environments_v1-proto) - [CreateOptions](#environments-CreateOptions) - [DeleteOptions](#environments-DeleteOptions) @@ -55,10 +49,138 @@ - [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

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

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

- -## 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

@@ -745,6 +687,64 @@ 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,3 +765,4 @@ Service for handling environments | 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