diff --git a/.woodpecker/documentation.yaml b/.woodpecker/documentation.yaml new file mode 100644 index 0000000..914283f --- /dev/null +++ b/.woodpecker/documentation.yaml @@ -0,0 +1,30 @@ +--- +when: + event: + - push + +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") + - 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" + - git -C /tmp/repo push diff --git a/.woodpecker/lint.yaml b/.woodpecker/lint.yaml new file mode 100644 index 0000000..d799fb7 --- /dev/null +++ b/.woodpecker/lint.yaml @@ -0,0 +1,11 @@ +--- +when: + event: + - push + +steps: + lint: + name: Lint protobufs + image: yoheimuta/protolint + commands: + - protolint lint $(find . -type f -iname "*.proto") diff --git a/README.md b/README.md index 5df53b8..eaad604 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,9 @@ - [accounts/accounts_v1.proto](#accounts_accounts_v1-proto) - [AccountData](#accounts-AccountData) - [AccountFull](#accounts-AccountFull) + - [AccountFullWithToken](#accounts-AccountFullWithToken) - [AccountId](#accounts-AccountId) - [AccountPassword](#accounts-AccountPassword) - - [AccountWithKubeConfig](#accounts-AccountWithKubeConfig) - [AccountWithPassword](#accounts-AccountWithPassword) - [Accounts](#accounts-Accounts) @@ -130,6 +130,7 @@ This file has messages for describing environments | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | name | [string](#string) | | Account name | +| email | [string](#string) | | Account email | @@ -152,6 +153,23 @@ This file has messages for describing environments + + +### AccountFullWithToken + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [AccountId](#accounts-AccountId) | | | +| data | [AccountData](#accounts-AccountData) | | | +| Token | [string](#string) | | | + + + + + + ### AccountId @@ -182,16 +200,6 @@ Represents a environment UUID only - - -### AccountWithKubeConfig - - - - - - - ### AccountWithPassword @@ -221,8 +229,8 @@ Service for handling environments | Method Name | Request Type | Response Type | Description | | ----------- | ------------ | ------------- | ------------| -| SignUp | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFull](#accounts-AccountFull) | | -| SignIn | [AccountWithPassword](#accounts-AccountWithPassword) | [.google.protobuf.Empty](#google-protobuf-Empty) | | +| SignUp | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | | +| SignIn | [AccountWithPassword](#accounts-AccountWithPassword) | [AccountFullWithToken](#accounts-AccountFullWithToken) | | diff --git a/proto/accounts/accounts_v1.proto b/proto/accounts/accounts_v1.proto index 5d4dc07..633b946 100644 --- a/proto/accounts/accounts_v1.proto +++ b/proto/accounts/accounts_v1.proto @@ -1,15 +1,14 @@ /// This file has messages for describing environments syntax = "proto3"; package accounts; -import "google/protobuf/empty.proto"; option go_package = "git.badhouseplants.net/softplayer/softplayer-go-proto/pkg/accounts"; /** * Service for handling environments */ service Accounts { - rpc SignUp (AccountWithPassword) returns (AccountFull) {} - rpc SignIn (AccountWithPassword) returns (google.protobuf.Empty) {} + rpc SignUp (AccountWithPassword) returns (AccountFullWithToken) {} + rpc SignIn (AccountWithPassword) returns (AccountFullWithToken) {} } /** @@ -39,7 +38,9 @@ message AccountFull { AccountData data = 2; } -message AccountWithKubeConfig { - +message AccountFullWithToken { + AccountId id = 1; + AccountData data = 2; + string Token = 3; }