Update documentation from 5635779253
This commit is contained in:
parent
ab817731e0
commit
d1e097b1eb
268
README.md
268
README.md
@ -3,6 +3,16 @@
|
|||||||
|
|
||||||
## Table of Contents
|
## 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)
|
||||||
|
|
||||||
- [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)
|
||||||
@ -23,16 +33,6 @@
|
|||||||
|
|
||||||
- [Environments](#environments-Environments)
|
- [Environments](#environments-Environments)
|
||||||
|
|
||||||
- [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)
|
- [email/email_v1.proto](#email_email_v1-proto)
|
||||||
- [ConfirmValidation](#email-ConfirmValidation)
|
- [ConfirmValidation](#email-ConfirmValidation)
|
||||||
- [RequestValidation](#email-RequestValidation)
|
- [RequestValidation](#email-RequestValidation)
|
||||||
@ -59,6 +59,129 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="accounts_accounts_v1-proto"></a>
|
||||||
|
<p align="right"><a href="#top">Top</a></p>
|
||||||
|
|
||||||
|
## accounts/accounts_v1.proto
|
||||||
|
This file has messages for describing environments
|
||||||
|
|
||||||
|
|
||||||
|
<a name="accounts-AccountData"></a>
|
||||||
|
|
||||||
|
### AccountData
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| name | [string](#string) | | Account name |
|
||||||
|
| email | [string](#string) | | Account email |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="accounts-AccountFull"></a>
|
||||||
|
|
||||||
|
### AccountFull
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| id | [AccountId](#accounts-AccountId) | | |
|
||||||
|
| data | [AccountData](#accounts-AccountData) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="accounts-AccountFullWithToken"></a>
|
||||||
|
|
||||||
|
### AccountFullWithToken
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| id | [AccountId](#accounts-AccountId) | | |
|
||||||
|
| data | [AccountData](#accounts-AccountData) | | |
|
||||||
|
| token | [string](#string) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="accounts-AccountId"></a>
|
||||||
|
|
||||||
|
### AccountId
|
||||||
|
Represents a environment UUID only
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| id | [string](#string) | | Contour ID: UUID |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="accounts-AccountPassword"></a>
|
||||||
|
|
||||||
|
### AccountPassword
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| password | [string](#string) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="accounts-AccountWithPassword"></a>
|
||||||
|
|
||||||
|
### AccountWithPassword
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| data | [AccountData](#accounts-AccountData) | | |
|
||||||
|
| password | [AccountPassword](#accounts-AccountPassword) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="accounts-Accounts"></a>
|
||||||
|
|
||||||
|
### 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) | |
|
||||||
|
| ResetPassword | [AccountData](#accounts-AccountData) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="environments_environments_v1-proto"></a>
|
<a name="environments_environments_v1-proto"></a>
|
||||||
<p align="right"><a href="#top">Top</a></p>
|
<p align="right"><a href="#top">Top</a></p>
|
||||||
|
|
||||||
@ -333,129 +456,6 @@ Service for handling environments
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="accounts_accounts_v1-proto"></a>
|
|
||||||
<p align="right"><a href="#top">Top</a></p>
|
|
||||||
|
|
||||||
## accounts/accounts_v1.proto
|
|
||||||
This file has messages for describing environments
|
|
||||||
|
|
||||||
|
|
||||||
<a name="accounts-AccountData"></a>
|
|
||||||
|
|
||||||
### AccountData
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| name | [string](#string) | | Account name |
|
|
||||||
| email | [string](#string) | | Account email |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="accounts-AccountFull"></a>
|
|
||||||
|
|
||||||
### AccountFull
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| id | [AccountId](#accounts-AccountId) | | |
|
|
||||||
| data | [AccountData](#accounts-AccountData) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="accounts-AccountFullWithToken"></a>
|
|
||||||
|
|
||||||
### AccountFullWithToken
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| id | [AccountId](#accounts-AccountId) | | |
|
|
||||||
| data | [AccountData](#accounts-AccountData) | | |
|
|
||||||
| token | [string](#string) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="accounts-AccountId"></a>
|
|
||||||
|
|
||||||
### AccountId
|
|
||||||
Represents a environment UUID only
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| id | [string](#string) | | Contour ID: UUID |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="accounts-AccountPassword"></a>
|
|
||||||
|
|
||||||
### AccountPassword
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| password | [string](#string) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="accounts-AccountWithPassword"></a>
|
|
||||||
|
|
||||||
### AccountWithPassword
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| data | [AccountData](#accounts-AccountData) | | |
|
|
||||||
| password | [AccountPassword](#accounts-AccountPassword) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="accounts-Accounts"></a>
|
|
||||||
|
|
||||||
### 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) | |
|
|
||||||
| ResetPassword | [AccountData](#accounts-AccountData) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="email_email_v1-proto"></a>
|
<a name="email_email_v1-proto"></a>
|
||||||
<p align="right"><a href="#top">Top</a></p>
|
<p align="right"><a href="#top">Top</a></p>
|
||||||
|
|
||||||
@ -767,4 +767,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 Mon May 20 20:12:37 UTC 2024
|
Generated on Tue May 21 07:10:09 UTC 2024
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user