Only the test service
Signed-off-by: Nikolai Rodionov <allanger@badhouseplants.net>
This commit is contained in:
@@ -1,6 +0,0 @@
|
||||
# Lint directives.
|
||||
lint:
|
||||
rules_option:
|
||||
max_line_length:
|
||||
max_chars: 120
|
||||
tab_chars: 2
|
||||
143
README.md
143
README.md
@@ -3,150 +3,37 @@
|
||||
|
||||
## 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)
|
||||
- [AccountWithPasswordAndCode](#accounts-AccountWithPasswordAndCode)
|
||||
- [EmailVerified](#accounts-EmailVerified)
|
||||
- [test/v1/test_v1.proto](#test_v1_test_v1-proto)
|
||||
- [PingRequest](#test-v1-PingRequest)
|
||||
- [PingResponse](#test-v1-PingResponse)
|
||||
|
||||
- [Accounts](#accounts-Accounts)
|
||||
- [TestService](#test-v1-TestService)
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
||||
|
||||
<a name="accounts_accounts_v1-proto"></a>
|
||||
<a name="test_v1_test_v1-proto"></a>
|
||||
<p align="right"><a href="#top">Top</a></p>
|
||||
|
||||
## accounts/accounts_v1.proto
|
||||
This file has messages for describing environments
|
||||
## test/v1/test_v1.proto
|
||||
|
||||
|
||||
<a name="accounts-AccountData"></a>
|
||||
|
||||
### AccountData
|
||||
<a name="test-v1-PingRequest"></a>
|
||||
|
||||
### PingRequest
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| name | [string](#string) | | Account name |
|
||||
| email | [string](#string) | | Account email |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="test-v1-PingResponse"></a>
|
||||
|
||||
<a name="accounts-AccountFull"></a>
|
||||
### PingResponse
|
||||
|
||||
### 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-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) | | |
|
||||
|
||||
|
||||
|
||||
@@ -159,18 +46,14 @@ Represents a environment UUID only
|
||||
|
||||
|
||||
|
||||
<a name="accounts-Accounts"></a>
|
||||
<a name="test-v1-TestService"></a>
|
||||
|
||||
### Accounts
|
||||
### TestService
|
||||
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) | |
|
||||
| NewPassword | [AccountWithPasswordAndCode](#accounts-AccountWithPasswordAndCode) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
|
||||
| IsEmailVerified | [AccountData](#accounts-AccountData) | [EmailVerified](#accounts-EmailVerified) | |
|
||||
| Ping | [PingRequest](#test-v1-PingRequest) | [PingResponse](#test-v1-PingResponse) | |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
/// This file has messages for describing environments
|
||||
syntax = "proto3";
|
||||
package accounts;
|
||||
import "google/protobuf/empty.proto";
|
||||
option go_package = "gitea.badhouseplants.net/softplayer/softplayer-go-proto/pkg/accounts";
|
||||
|
||||
/**
|
||||
* Service for handling environments
|
||||
*/
|
||||
service Accounts {
|
||||
rpc SignUp (AccountWithPassword) returns (AccountFullWithToken) {}
|
||||
rpc SignIn (AccountWithPassword) returns (AccountFullWithToken) {}
|
||||
rpc ResetPassword (AccountData) returns (google.protobuf.Empty) {}
|
||||
rpc NewPassword (AccountWithPasswordAndCode) returns (google.protobuf.Empty) {}
|
||||
rpc IsEmailVerified (AccountData) returns (EmailVerified) {}
|
||||
}
|
||||
|
||||
message EmailVerified {
|
||||
bool verified = 1;
|
||||
}
|
||||
/**
|
||||
* Represents a environment UUID only
|
||||
*/
|
||||
message AccountId {
|
||||
string id = 1; // Contour ID: UUID
|
||||
}
|
||||
|
||||
message AccountPassword {
|
||||
string password = 1;
|
||||
}
|
||||
|
||||
|
||||
message AccountData {
|
||||
string name = 1; // Account name
|
||||
string email = 2; // Account email
|
||||
}
|
||||
|
||||
message AccountWithPassword {
|
||||
AccountData data = 1;
|
||||
AccountPassword password = 2;
|
||||
}
|
||||
|
||||
message AccountWithPasswordAndCode {
|
||||
AccountData data = 1;
|
||||
AccountPassword password = 2;
|
||||
string code = 3;
|
||||
}
|
||||
|
||||
|
||||
message AccountFull {
|
||||
AccountId id = 1;
|
||||
AccountData data = 2;
|
||||
}
|
||||
|
||||
message AccountFullWithToken {
|
||||
AccountId id = 1;
|
||||
AccountData data = 2;
|
||||
string token = 3;
|
||||
}
|
||||
14
proto/test/v1/test_v1.proto
Normal file
14
proto/test/v1/test_v1.proto
Normal file
@@ -0,0 +1,14 @@
|
||||
syntax = "proto3";
|
||||
package test.v1;
|
||||
option go_package = "gitea.badhouseplants.net/softplayer/softplayer-go-proto/pkg/test/v1";
|
||||
|
||||
/**
|
||||
* Service for handling environments
|
||||
*/
|
||||
service TestService {
|
||||
rpc Ping (PingRequest) returns (PingResponse) {}
|
||||
}
|
||||
|
||||
message PingRequest {}
|
||||
|
||||
message PingResponse {}
|
||||
Reference in New Issue
Block a user