Compare commits
34 Commits
v0.1.13
...
update-js-
| Author | SHA1 | Date | |
|---|---|---|---|
|
0b1979e4f1
|
|||
|
73f000791a
|
|||
|
1d3ceb07da
|
|||
|
ed3bc02006
|
|||
|
b3d0888cc8
|
|||
|
b9154d1062
|
|||
|
f3e2a9dea1
|
|||
|
22e8ba2da5
|
|||
|
cf30d5f2f2
|
|||
|
674ffc982d
|
|||
|
08bd14d5f0
|
|||
|
bb5a976a1b
|
|||
|
ed05cf345a
|
|||
|
418fb64387
|
|||
| 2b810cf630 | |||
|
7f6a3e117e
|
|||
|
659f9f8500
|
|||
|
1b1e500ef8
|
|||
|
0c909c00e1
|
|||
|
7a23c4cacb
|
|||
|
397e515f34
|
|||
|
f46757640b
|
|||
|
dab66a561c
|
|||
|
bc6cb2a6e0
|
|||
|
c63c766895
|
|||
|
d518a692b2
|
|||
|
b643af2f3d
|
|||
|
54e1cedeb0
|
|||
|
c2ec945fa4
|
|||
|
4c45fd39fb
|
|||
|
066985346d
|
|||
|
|
19468be271 | ||
| eb82a632ce | |||
| 165fe024d9 |
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
gen/
|
||||||
11
.pre-commit-config.yaml
Normal file
11
.pre-commit-config.yaml
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
repos:
|
||||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
|
rev: v6.0.0 # Use the ref you want to point at
|
||||||
|
hooks:
|
||||||
|
- id: trailing-whitespace
|
||||||
|
exclude: README.md
|
||||||
|
- id: check-added-large-files
|
||||||
|
- id: check-case-conflict
|
||||||
|
- id: check-merge-conflict
|
||||||
|
- id: end-of-file-fixer
|
||||||
|
exclude: README.md
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
# Lint directives.
|
|
||||||
lint:
|
|
||||||
rules_option:
|
|
||||||
max_line_length:
|
|
||||||
max_chars: 120
|
|
||||||
tab_chars: 2
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
---
|
|
||||||
when:
|
|
||||||
event:
|
|
||||||
- push
|
|
||||||
branch: main
|
|
||||||
|
|
||||||
steps:
|
|
||||||
lint:
|
|
||||||
name: Generate docs
|
|
||||||
image: pseudomuto/protoc-gen-doc
|
|
||||||
secrets:
|
|
||||||
- softplayer_bot_ssh_key
|
|
||||||
- git_known_hosts
|
|
||||||
commands:
|
|
||||||
- mkdir -p ~/.ssh
|
|
||||||
- apk update && apk add git openssh
|
|
||||||
- echo $SOFTPLAYER_BOT_SSH_KEY | base64 -d > ~/.ssh/id_ed25519
|
|
||||||
- echo $GIT_KNOWN_HOSTS > ~/.ssh/known_hosts
|
|
||||||
- cat ~/.ssh/id_ed25519
|
|
||||||
- chmod 0600 ~/.ssh/id_ed25519
|
|
||||||
- protoc --proto_path=./proto --doc_out=. --doc_opt=markdown,README.md $(find ./proto -type f -iname "*.proto")
|
|
||||||
# To make sure there is always a change, even when protos are not updated
|
|
||||||
- echo "Generated on $(date)" >> README.md
|
|
||||||
- eval `ssh-agent`
|
|
||||||
- ssh-add ~/.ssh/id_ed25519
|
|
||||||
- git config --global user.email "allanger@badhouseplants.net"
|
|
||||||
- git config --global user.name "Softplayer Bot"
|
|
||||||
- git clone git@git.badhouseplants.net:softplayer/softplayer-proto.git /tmp/repo
|
|
||||||
- git -C /tmp/repo checkout generated-documentation
|
|
||||||
- mv README.md /tmp/repo/README.md
|
|
||||||
- git -C /tmp/repo add .
|
|
||||||
- git -C /tmp/repo commit -m "Update documentation from $CI_COMMIT_SHA"
|
|
||||||
- git -C /tmp/repo push
|
|
||||||
42
.woodpecker/go-generate.yaml
Normal file
42
.woodpecker/go-generate.yaml
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
---
|
||||||
|
when:
|
||||||
|
event:
|
||||||
|
- push
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Clone go repo
|
||||||
|
image: alpine
|
||||||
|
environment:
|
||||||
|
GITEA_USER: devops-bot
|
||||||
|
GITEA_TOKEN:
|
||||||
|
from_secret: gitea_repo_access
|
||||||
|
commands:
|
||||||
|
- apk update && apk add git
|
||||||
|
- git clone https://$GITEA_USER:$GITEA_TOKEN@gitea.badhouseplants.net/softplayer/softplayer-go-proto.git target
|
||||||
|
- git -C ./target config user.name "devops-bot"
|
||||||
|
- git -C ./target config user.email "bot@badhouseplants.net"
|
||||||
|
- name: Generate go code
|
||||||
|
image: bufbuild/buf
|
||||||
|
commands:
|
||||||
|
- buf generate
|
||||||
|
- rm -rf ./target/pkg/*
|
||||||
|
- cp -r ./gen/go/* ./target/pkg
|
||||||
|
- name: Clone go repo
|
||||||
|
image: alpine
|
||||||
|
environment:
|
||||||
|
GITEA_USER: devops-bot
|
||||||
|
GITEA_TOKEN:
|
||||||
|
from_secret: gitea_repo_access
|
||||||
|
commands:
|
||||||
|
- apk update && apk add git
|
||||||
|
- git config user.name "woodpecker-ci"
|
||||||
|
- git config user.email "bot@badhouseplants.net"
|
||||||
|
- git -C ./target checkout $CI_COMMIT_BRANCH || git -C ./target checkout -b $CI_COMMIT_BRANCH
|
||||||
|
- git -C ./target add .
|
||||||
|
- |-
|
||||||
|
git -C ./target commit --allow-empty \
|
||||||
|
-m "Update protobuf definitions: ${CI_COMMIT_SHA:0:8}" \
|
||||||
|
-m "By ${CI_COMMIT_AUTHOR}" \
|
||||||
|
-m "Commit link: ${CI_REPO_URL}/commit/${CI_COMMIT_SHA}" \
|
||||||
|
-m "Pipeline link: ${CI_PIPELINE_URL}"
|
||||||
|
- git -C ./target push --set-upstream origin $CI_COMMIT_BRANCH
|
||||||
43
.woodpecker/js-generate.yaml
Normal file
43
.woodpecker/js-generate.yaml
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
when:
|
||||||
|
event:
|
||||||
|
- push
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Clone js repo
|
||||||
|
image: alpine
|
||||||
|
environment:
|
||||||
|
GITEA_USER: devops-bot
|
||||||
|
GITEA_TOKEN:
|
||||||
|
from_secret: gitea_repo_access
|
||||||
|
commands:
|
||||||
|
- apk update && apk add git
|
||||||
|
- git clone https://$GITEA_USER:$GITEA_TOKEN@gitea.badhouseplants.net/softplayer/softplayer-js-proto.git target
|
||||||
|
- git -C ./target config user.name "devops-bot"
|
||||||
|
- git -C ./target config user.email "bot@badhouseplants.net"
|
||||||
|
- name: Generate js code
|
||||||
|
image: bufbuild/buf
|
||||||
|
commands:
|
||||||
|
- buf generate
|
||||||
|
- rm -rf ./target/src/api
|
||||||
|
- mkdir -p ./target/src/api
|
||||||
|
- cp -r ./gen/ts/* ./target/src/api
|
||||||
|
- name: Clone go repo
|
||||||
|
image: alpine
|
||||||
|
environment:
|
||||||
|
GITEA_USER: devops-bot
|
||||||
|
GITEA_TOKEN:
|
||||||
|
from_secret: gitea_repo_access
|
||||||
|
commands:
|
||||||
|
- apk update && apk add git
|
||||||
|
- git config user.name "woodpecker-ci"
|
||||||
|
- git config user.email "bot@badhouseplants.net"
|
||||||
|
- git -C ./target checkout $CI_COMMIT_BRANCH || git -C ./target checkout -b $CI_COMMIT_BRANCH
|
||||||
|
- git -C ./target add .
|
||||||
|
- |-
|
||||||
|
git -C ./target commit --allow-empty \
|
||||||
|
-m "Update protobuf definitions: ${CI_COMMIT_SHA:0:8}" \
|
||||||
|
-m "By ${CI_COMMIT_AUTHOR}" \
|
||||||
|
-m "Commit link: ${CI_REPO_URL}/commit/${CI_COMMIT_SHA}" \
|
||||||
|
-m "Pipeline link: ${CI_PIPELINE_URL}"
|
||||||
|
- git -C ./target push --set-upstream origin $CI_COMMIT_BRANCH
|
||||||
@@ -4,8 +4,7 @@ when:
|
|||||||
- push
|
- push
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
lint:
|
- name: Lint protobufs
|
||||||
name: Lint protobufs
|
image: bufbuild/buf
|
||||||
image: yoheimuta/protolint
|
|
||||||
commands:
|
commands:
|
||||||
- protolint lint $(find . -type f -iname "*.proto")
|
- buf lint
|
||||||
|
|||||||
10
.woodpecker/repo-checks.yaml
Normal file
10
.woodpecker/repo-checks.yaml
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
when:
|
||||||
|
event:
|
||||||
|
- push
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Run pre-commit
|
||||||
|
image: jfxs/pre-commit
|
||||||
|
commands:
|
||||||
|
- pre-commit run --all
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
FROM alpine:3.16.2
|
|
||||||
|
|
||||||
RUN apk add --no-cache git make musl-dev go protobuf protobuf-dev
|
|
||||||
ENV GOROOT /usr/lib/go
|
|
||||||
ENV GOPATH /go
|
|
||||||
ENV PATH /go/bin:$PATH
|
|
||||||
RUN go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.26
|
|
||||||
RUN go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.1
|
|
||||||
|
|
||||||
CMD [ "protoc -v" ]
|
|
||||||
|
|
||||||
36
Makefile
36
Makefile
@@ -1,36 +0,0 @@
|
|||||||
# ---------------------------------------------------------------------
|
|
||||||
# -- Which container tool to use
|
|
||||||
# ---------------------------------------------------------------------
|
|
||||||
CONTAINER_TOOL ?= docker
|
|
||||||
|
|
||||||
protoc-docs-gen:
|
|
||||||
protoc \
|
|
||||||
--proto_path=./proto \
|
|
||||||
--doc_out=. \
|
|
||||||
--doc_opt=markdown,readme.md \
|
|
||||||
$$(find ./proto -type f -iname "*.proto")
|
|
||||||
|
|
||||||
docker-docs-gen:
|
|
||||||
$(CONTAINER_TOOL) run --rm \
|
|
||||||
-v $$(pwd):/out \
|
|
||||||
-v $$(pwd)/proto:/proto \
|
|
||||||
pseudomuto/protoc-gen-doc --doc_opt=markdown,README.md --proto_path=proto \
|
|
||||||
$$(find proto -type f -iname "*.proto")
|
|
||||||
|
|
||||||
docker-lint:
|
|
||||||
$(CONTAINER_TOOL) run --rm \
|
|
||||||
-v $$(pwd):/workspace \
|
|
||||||
--workdir /workspace \
|
|
||||||
yoheimuta/protolint lint \
|
|
||||||
$$(find . -type f -iname "*.proto")
|
|
||||||
|
|
||||||
docker-protobuf:
|
|
||||||
$(CONTAINER_TOOL) build -t gogen . && \
|
|
||||||
$(CONTAINER_TOOL) run --rm \
|
|
||||||
-v $$(pwd)/proto:/proto \
|
|
||||||
-v $$(pwd)/pkg:/pkg \
|
|
||||||
gogen \
|
|
||||||
protoc --go_out=/pkg/ --go_opt=paths=source_relative \
|
|
||||||
--go-grpc_out=/pkg/ --go-grpc_opt=paths=source_relative \
|
|
||||||
--proto_path=proto/proto \
|
|
||||||
$$(find proto -type f -iname "*.proto")
|
|
||||||
899
README.md
899
README.md
@@ -3,7 +3,41 @@
|
|||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [environments/environments_v1.proto](#environments_environments_v1-proto)
|
- [accounts/v1/accounts_v1.proto](#accounts_v1_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)
|
||||||
|
|
||||||
|
- [Accounts](#accounts-Accounts)
|
||||||
|
|
||||||
|
- [applications/v1/applications_v1.proto](#applications_v1_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/v1/email_v1.proto](#email_v1_email_v1-proto)
|
||||||
|
- [ConfirmValidation](#email-ConfirmValidation)
|
||||||
|
- [RequestValidation](#email-RequestValidation)
|
||||||
|
|
||||||
|
- [EmailValidation](#email-EmailValidation)
|
||||||
|
|
||||||
|
- [environments/v1/environments_v1.proto](#environments_v1_environments_v1-proto)
|
||||||
- [CreateOptions](#environments-CreateOptions)
|
- [CreateOptions](#environments-CreateOptions)
|
||||||
- [DeleteOptions](#environments-DeleteOptions)
|
- [DeleteOptions](#environments-DeleteOptions)
|
||||||
- [EnvironmentFull](#environments-EnvironmentFull)
|
- [EnvironmentFull](#environments-EnvironmentFull)
|
||||||
@@ -23,46 +57,470 @@
|
|||||||
|
|
||||||
- [Environments](#environments-Environments)
|
- [Environments](#environments-Environments)
|
||||||
|
|
||||||
- [accounts/accounts_v1.proto](#accounts_accounts_v1-proto)
|
- [test/v1/test_v1.proto](#test_v1_test_v1-proto)
|
||||||
- [AccountData](#accounts-AccountData)
|
- [PingRequest](#test-v1-PingRequest)
|
||||||
- [AccountFull](#accounts-AccountFull)
|
- [PingResponse](#test-v1-PingResponse)
|
||||||
- [AccountFullWithToken](#accounts-AccountFullWithToken)
|
- [PongRequest](#test-v1-PongRequest)
|
||||||
- [AccountId](#accounts-AccountId)
|
- [PongResponse](#test-v1-PongResponse)
|
||||||
- [AccountPassword](#accounts-AccountPassword)
|
|
||||||
- [AccountWithPassword](#accounts-AccountWithPassword)
|
|
||||||
|
|
||||||
- [Accounts](#accounts-Accounts)
|
- [TestService](#test-v1-TestService)
|
||||||
|
|
||||||
- [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)
|
|
||||||
|
|
||||||
- [Scalar Value Types](#scalar-value-types)
|
- [Scalar Value Types](#scalar-value-types)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="environments_environments_v1-proto"></a>
|
<a name="accounts_v1_accounts_v1-proto"></a>
|
||||||
<p align="right"><a href="#top">Top</a></p>
|
<p align="right"><a href="#top">Top</a></p>
|
||||||
|
|
||||||
## environments/environments_v1.proto
|
## accounts/v1/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-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) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<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) | |
|
||||||
|
| NewPassword | [AccountWithPasswordAndCode](#accounts-AccountWithPasswordAndCode) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
|
||||||
|
| IsEmailVerified | [AccountData](#accounts-AccountData) | [EmailVerified](#accounts-EmailVerified) | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications_v1_applications_v1-proto"></a>
|
||||||
|
<p align="right"><a href="#top">Top</a></p>
|
||||||
|
|
||||||
|
## applications/v1/applications_v1.proto
|
||||||
|
This file has messages for describing applications
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-ApplicationFull"></a>
|
||||||
|
|
||||||
|
### ApplicationFull
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
|
||||||
|
| spec | [ApplicationSpec](#applications-ApplicationSpec) | | |
|
||||||
|
| id | [ApplicationId](#applications-ApplicationId) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-ApplicationId"></a>
|
||||||
|
|
||||||
|
### ApplicationId
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| uuid | [string](#string) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-ApplicationMetadata"></a>
|
||||||
|
|
||||||
|
### ApplicationMetadata
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| name | [string](#string) | | |
|
||||||
|
| description | [string](#string) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-ApplicationSpec"></a>
|
||||||
|
|
||||||
|
### 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) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-ApplicationSpec-ConfigEntry"></a>
|
||||||
|
|
||||||
|
### ApplicationSpec.ConfigEntry
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| key | [string](#string) | | |
|
||||||
|
| value | [string](#string) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-CreateOptions"></a>
|
||||||
|
|
||||||
|
### CreateOptions
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
|
||||||
|
| spec | [ApplicationSpec](#applications-ApplicationSpec) | | |
|
||||||
|
| owner_id | [OwnerId](#applications-OwnerId) | | |
|
||||||
|
| token | [Token](#applications-Token) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-DeleteOptions"></a>
|
||||||
|
|
||||||
|
### DeleteOptions
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| id | [ApplicationId](#applications-ApplicationId) | | |
|
||||||
|
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
|
||||||
|
| owner_id | [OwnerId](#applications-OwnerId) | | |
|
||||||
|
| token | [Token](#applications-Token) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-GetOptions"></a>
|
||||||
|
|
||||||
|
### GetOptions
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| id | [ApplicationId](#applications-ApplicationId) | | |
|
||||||
|
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
|
||||||
|
| owner_id | [OwnerId](#applications-OwnerId) | | |
|
||||||
|
| token | [Token](#applications-Token) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-ListOptions"></a>
|
||||||
|
|
||||||
|
### ListOptions
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
|
||||||
|
| owner_id | [OwnerId](#applications-OwnerId) | | |
|
||||||
|
| token | [Token](#applications-Token) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-OwnerId"></a>
|
||||||
|
|
||||||
|
### OwnerId
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| uuid | [string](#string) | | UUID of a user that is creating an environemnt |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-Token"></a>
|
||||||
|
|
||||||
|
### Token
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| token | [string](#string) | | Token that should be used to create an environment |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-UpdateOptions"></a>
|
||||||
|
|
||||||
|
### 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) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="applications-Applications"></a>
|
||||||
|
|
||||||
|
### 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 | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="email_v1_email_v1-proto"></a>
|
||||||
|
<p align="right"><a href="#top">Top</a></p>
|
||||||
|
|
||||||
|
## email/v1/email_v1.proto
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="email-ConfirmValidation"></a>
|
||||||
|
|
||||||
|
### ConfirmValidation
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| user_id | [string](#string) | | |
|
||||||
|
| code | [int32](#int32) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="email-RequestValidation"></a>
|
||||||
|
|
||||||
|
### RequestValidation
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| user_id | [string](#string) | | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="email-EmailValidation"></a>
|
||||||
|
|
||||||
|
### 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) | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="environments_v1_environments_v1-proto"></a>
|
||||||
|
<p align="right"><a href="#top">Top</a></p>
|
||||||
|
|
||||||
|
## environments/v1/environments_v1.proto
|
||||||
This file has messages for describing environments
|
This file has messages for describing environments
|
||||||
|
|
||||||
|
|
||||||
@@ -333,415 +791,68 @@ Service for handling environments
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="accounts_accounts_v1-proto"></a>
|
<a name="test_v1_test_v1-proto"></a>
|
||||||
<p align="right"><a href="#top">Top</a></p>
|
<p align="right"><a href="#top">Top</a></p>
|
||||||
|
|
||||||
## accounts/accounts_v1.proto
|
## test/v1/test_v1.proto
|
||||||
This file has messages for describing environments
|
|
||||||
|
|
||||||
|
|
||||||
<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="test-v1-PongRequest"></a>
|
||||||
|
|
||||||
|
### PongRequest
|
||||||
|
|
||||||
|
|
||||||
<a name="accounts-AccountFullWithToken"></a>
|
|
||||||
|
|
||||||
### AccountFullWithToken
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| id | [AccountId](#accounts-AccountId) | | |
|
|
||||||
| data | [AccountData](#accounts-AccountData) | | |
|
|
||||||
| token | [string](#string) | | |
|
|
||||||
|
|
||||||
|
<a name="test-v1-PongResponse"></a>
|
||||||
|
|
||||||
|
### PongResponse
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
<a name="test-v1-TestService"></a>
|
||||||
|
|
||||||
### AccountPassword
|
### TestService
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| 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
|
Service for handling environments
|
||||||
|
|
||||||
| Method Name | Request Type | Response Type | Description |
|
| Method Name | Request Type | Response Type | Description |
|
||||||
| ----------- | ------------ | ------------- | ------------|
|
| ----------- | ------------ | ------------- | ------------|
|
||||||
| SignUp | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | |
|
| Ping | [PingRequest](#test-v1-PingRequest) | [PingResponse](#test-v1-PingResponse) | |
|
||||||
| SignIn | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | |
|
| Pong | [PongRequest](#test-v1-PongRequest) | [PongResponse](#test-v1-PongResponse) | |
|
||||||
| ResetPassword | [AccountData](#accounts-AccountData) | [.google.protobuf.Empty](#google-protobuf-Empty) | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications_applications_v1-proto"></a>
|
|
||||||
<p align="right"><a href="#top">Top</a></p>
|
|
||||||
|
|
||||||
## applications/applications_v1.proto
|
|
||||||
This file has messages for describing applications
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-ApplicationFull"></a>
|
|
||||||
|
|
||||||
### ApplicationFull
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
|
|
||||||
| spec | [ApplicationSpec](#applications-ApplicationSpec) | | |
|
|
||||||
| id | [ApplicationId](#applications-ApplicationId) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-ApplicationId"></a>
|
|
||||||
|
|
||||||
### ApplicationId
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| uuid | [string](#string) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-ApplicationMetadata"></a>
|
|
||||||
|
|
||||||
### ApplicationMetadata
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| name | [string](#string) | | |
|
|
||||||
| description | [string](#string) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-ApplicationSpec"></a>
|
|
||||||
|
|
||||||
### 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) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-ApplicationSpec-ConfigEntry"></a>
|
|
||||||
|
|
||||||
### ApplicationSpec.ConfigEntry
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| key | [string](#string) | | |
|
|
||||||
| value | [string](#string) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-CreateOptions"></a>
|
|
||||||
|
|
||||||
### CreateOptions
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
|
|
||||||
| spec | [ApplicationSpec](#applications-ApplicationSpec) | | |
|
|
||||||
| owner_id | [OwnerId](#applications-OwnerId) | | |
|
|
||||||
| token | [Token](#applications-Token) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-DeleteOptions"></a>
|
|
||||||
|
|
||||||
### DeleteOptions
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| id | [ApplicationId](#applications-ApplicationId) | | |
|
|
||||||
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
|
|
||||||
| owner_id | [OwnerId](#applications-OwnerId) | | |
|
|
||||||
| token | [Token](#applications-Token) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-GetOptions"></a>
|
|
||||||
|
|
||||||
### GetOptions
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| id | [ApplicationId](#applications-ApplicationId) | | |
|
|
||||||
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
|
|
||||||
| owner_id | [OwnerId](#applications-OwnerId) | | |
|
|
||||||
| token | [Token](#applications-Token) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-ListOptions"></a>
|
|
||||||
|
|
||||||
### ListOptions
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| metadata | [ApplicationMetadata](#applications-ApplicationMetadata) | | |
|
|
||||||
| owner_id | [OwnerId](#applications-OwnerId) | | |
|
|
||||||
| token | [Token](#applications-Token) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-OwnerId"></a>
|
|
||||||
|
|
||||||
### OwnerId
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| uuid | [string](#string) | | UUID of a user that is creating an environemnt |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-Token"></a>
|
|
||||||
|
|
||||||
### Token
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| token | [string](#string) | | Token that should be used to create an environment |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-UpdateOptions"></a>
|
|
||||||
|
|
||||||
### 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) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="applications-Applications"></a>
|
|
||||||
|
|
||||||
### 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 | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="email_email_v1-proto"></a>
|
|
||||||
<p align="right"><a href="#top">Top</a></p>
|
|
||||||
|
|
||||||
## email/email_v1.proto
|
|
||||||
This file has messages for describing environments
|
|
||||||
|
|
||||||
|
|
||||||
<a name="email-ConfirmValidation"></a>
|
|
||||||
|
|
||||||
### ConfirmValidation
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| user_id | [string](#string) | | |
|
|
||||||
| code | [int32](#int32) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="email-RequestValidation"></a>
|
|
||||||
|
|
||||||
### RequestValidation
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| user_id | [string](#string) | | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="email-EmailValidation"></a>
|
|
||||||
|
|
||||||
### 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) | |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
13
Taskfile.yml
Normal file
13
Taskfile.yml
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# yaml-language-server: $schema=https://taskfile.dev/schema.json
|
||||||
|
|
||||||
|
version: "3"
|
||||||
|
|
||||||
|
tasks:
|
||||||
|
lint:
|
||||||
|
desc: Run linter
|
||||||
|
silent: true
|
||||||
|
cmd: buf lint
|
||||||
|
generate:
|
||||||
|
desc: Generate code
|
||||||
|
silent: true
|
||||||
|
cmd: buf generate
|
||||||
22
buf.gen.yaml
Normal file
22
buf.gen.yaml
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
version: v2
|
||||||
|
plugins:
|
||||||
|
- remote: buf.build/bufbuild/es
|
||||||
|
out: gen/ts
|
||||||
|
opt:
|
||||||
|
- target=ts
|
||||||
|
|
||||||
|
- remote: buf.build/protocolbuffers/go
|
||||||
|
out: gen/go
|
||||||
|
opt:
|
||||||
|
- paths=source_relative
|
||||||
|
|
||||||
|
- remote: buf.build/grpc/go
|
||||||
|
out: gen/go
|
||||||
|
opt:
|
||||||
|
- paths=source_relative
|
||||||
|
- require_unimplemented_servers=false
|
||||||
|
|
||||||
|
- remote: buf.build/community/pseudomuto-doc:v1.5.1
|
||||||
|
out: .
|
||||||
|
opt:
|
||||||
|
- markdown,README.md
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
syntax = "proto3";
|
syntax = "proto3";
|
||||||
package accounts;
|
package accounts;
|
||||||
import "google/protobuf/empty.proto";
|
import "google/protobuf/empty.proto";
|
||||||
option go_package = "git.badhouseplants.net/softplayer/softplayer-go-proto/pkg/accounts";
|
option go_package = "gitea.badhouseplants.net/softplayer/softplayer-go-proto/pkg/accounts";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Service for handling environments
|
* Service for handling environments
|
||||||
@@ -11,8 +11,13 @@ service Accounts {
|
|||||||
rpc SignUp (AccountWithPassword) returns (AccountFullWithToken) {}
|
rpc SignUp (AccountWithPassword) returns (AccountFullWithToken) {}
|
||||||
rpc SignIn (AccountWithPassword) returns (AccountFullWithToken) {}
|
rpc SignIn (AccountWithPassword) returns (AccountFullWithToken) {}
|
||||||
rpc ResetPassword (AccountData) returns (google.protobuf.Empty) {}
|
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
|
* Represents a environment UUID only
|
||||||
*/
|
*/
|
||||||
@@ -35,6 +40,13 @@ message AccountWithPassword {
|
|||||||
AccountPassword password = 2;
|
AccountPassword password = 2;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
message AccountWithPasswordAndCode {
|
||||||
|
AccountData data = 1;
|
||||||
|
AccountPassword password = 2;
|
||||||
|
string code = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
message AccountFull {
|
message AccountFull {
|
||||||
AccountId id = 1;
|
AccountId id = 1;
|
||||||
AccountData data = 2;
|
AccountData data = 2;
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
syntax = "proto3";
|
syntax = "proto3";
|
||||||
package applications;
|
package applications;
|
||||||
import "google/protobuf/empty.proto";
|
import "google/protobuf/empty.proto";
|
||||||
option go_package = "git.badhouseplants.net/softplayer/softplayer-go-proto/pkg/applications";
|
option go_package = "gitea.badhouseplants.net/softplayer/softplayer-go-proto/pkg/applications";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Service for handling applications
|
* Service for handling applications
|
||||||
@@ -1,8 +1,7 @@
|
|||||||
/// This file has messages for describing environments
|
|
||||||
syntax = "proto3";
|
syntax = "proto3";
|
||||||
package email;
|
package email;
|
||||||
import "google/protobuf/empty.proto";
|
import "google/protobuf/empty.proto";
|
||||||
option go_package = "git.badhouseplants.net/softplayer/softplayer-go-proto/pkg/email";
|
option go_package = "gitea.badhouseplants.net/softplayer/softplayer-go-proto/pkg/email";
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* A service that should handle email validation
|
* A service that should handle email validation
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
syntax = "proto3";
|
syntax = "proto3";
|
||||||
package environments;
|
package environments;
|
||||||
import "google/protobuf/empty.proto";
|
import "google/protobuf/empty.proto";
|
||||||
option go_package = "git.badhouseplants.net/softplayer/softplayer-go-proto/pkg/environments";
|
option go_package = "gitea.badhouseplants.net/softplayer/softplayer-go-proto/pkg/environments";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Service for handling environments
|
* Service for handling environments
|
||||||
19
proto/test/v1/test_v1.proto
Normal file
19
proto/test/v1/test_v1.proto
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
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) {}
|
||||||
|
rpc Pong (PongRequest) returns (PongResponse) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
message PingRequest {}
|
||||||
|
|
||||||
|
message PingResponse {}
|
||||||
|
|
||||||
|
message PongRequest {}
|
||||||
|
|
||||||
|
message PongResponse {}
|
||||||
Reference in New Issue
Block a user