Reference
Package platform.v1.
| Service | RPC | Request | Response | REST |
|---|---|---|---|---|
HelloService | GetHello | GetHelloRequest | Hello | GET /api/hello |
IdentityService | Signup | SignupRequest | SignupResponse | POST /api/v1/signup |
IdentityService | CreateSession | SessionRequest | SessionOk | POST /api/v1/sessions |
IdentityService | DeleteSession | Empty | Empty | DELETE /api/v1/sessions |
IdentityService | GetSession | Empty | SessionView | GET /api/v1/session |
Messages
Section titled “Messages”No fields.
GetHelloRequest
Section titled “GetHelloRequest”No fields.
Hello is the sample greeting returned by the template backend.
| Field | Type | # | Notes |
|---|---|---|---|
message | string | 1 | |
source | string | 2 | source is “cloud” for the compose apiserver and “local” for local-backend. |
SessionOk
Section titled “SessionOk”| Field | Type | # | Notes |
|---|---|---|---|
ok | bool | 1 |
SessionRequest
Section titled “SessionRequest”| Field | Type | # | Notes |
|---|---|---|---|
email | string | 1 | |
password | string | 2 | |
shop_id | string | 3 |
SessionView
Section titled “SessionView”| Field | Type | # | Notes |
|---|---|---|---|
staff | Staff | 1 | |
shop | Shop | 2 | |
organization | Organization | 3 | |
role | string | 4 |
SignupRequest
Section titled “SignupRequest”| Field | Type | # | Notes |
|---|---|---|---|
organization_name | string | 1 | |
shop_name | string | 2 | |
shop_currency | string | 3 | |
owner_email | string | 4 | |
owner_password | string | 5 | |
billing_email | string | 6 |
SignupResponse
Section titled “SignupResponse”| Field | Type | # | Notes |
|---|---|---|---|
organization | Organization | 1 | |
shop | Shop | 2 | |
staff | Staff | 3 |