face.proto
path kilroy/face/v1alpha/face.proto
package kilroy.face.v1alpha
Definitions for face service.
Messages
GetConfigRequest
Request for GetConfig.
| Name | Type | Description |
|---|
GetConfigResponse
Response from GetConfig.
| Name | Type | Description |
|---|---|---|
config | string | The config of the face as a JSON string. |
GetConfigSchemaRequest
Request for GetConfigSchema.
| Name | Type | Description |
|---|
GetConfigSchemaResponse
Response from GetConfigSchema.
| Name | Type | Description |
|---|---|---|
schema | string | The schema of the face config as a JSON string. |
GetMetadataRequest
Request for GetMetadata.
| Name | Type | Description |
|---|
GetMetadataResponse
Response from GetMetadata.
| Name | Type | Description |
|---|---|---|
key | string | The key of the face. |
description | string | The description of the face. |
GetPostSchemaRequest
Request for GetPostSchema.
| Name | Type | Description |
|---|
GetPostSchemaResponse
Response from GetPostSchema.
| Name | Type | Description |
|---|---|---|
schema | string | The schema of a post as a JSON string. |
GetStatusRequest
Request for GetStatus.
| Name | Type | Description |
|---|
GetStatusResponse
Response from GetStatus.
| Name | Type | Description |
|---|---|---|
status | Status | The status of the face. |
PostRequest
Request for Post.
| Name | Type | Description |
|---|---|---|
content | string | The content of the post as a JSON string. |
PostResponse
Response from Post.
| Name | Type | Description |
|---|---|---|
id | string | The ID of the post. |
url | string | The URL of the post. |
ResetRequest
Request for Reset.
| Name | Type | Description |
|---|
ResetResponse
Response from Reset.
| Name | Type | Description |
|---|
SaveRequest
Request for Save.
| Name | Type | Description |
|---|
SaveResponse
Response from Save.
| Name | Type | Description |
|---|
ScoreRequest
Request for Score.
| Name | Type | Description |
|---|---|---|
id | string | The ID of the post to score. |
ScoreResponse
Response from Score.
| Name | Type | Description |
|---|---|---|
score | double | The score of the post. |
ScrapRequest
Request for Scrap.
| Name | Type | Description |
|---|---|---|
limit | uint64 | The maximum number of posts to scrap. |
before | google.protobuf.Timestamp | The maximum time of the posts to scrap. |
after | google.protobuf.Timestamp | The minimum time of the posts to scrap. |
ScrapResponse
Response from Scrap.
| Name | Type | Description |
|---|---|---|
id | string | The ID of the post. |
content | string | The content of the post as a JSON string. |
score | double | The score of the post. |
SetConfigRequest
Request for SetConfig.
| Name | Type | Description |
|---|---|---|
config | string | The config of the face as a JSON string. |
SetConfigResponse
Response from SetConfig.
| Name | Type | Description |
|---|---|---|
config | string | The config of the face as a JSON string. |
WatchConfigRequest
Request for WatchConfig.
| Name | Type | Description |
|---|
WatchConfigResponse
Response from WatchConfig.
| Name | Type | Description |
|---|---|---|
config | string | The config of the face as a JSON string. |
WatchStatusRequest
Request for WatchStatus.
| Name | Type | Description |
|---|
WatchStatusResponse
Response from WatchStatus.
| Name | Type | Description |
|---|---|---|
status | Status | The status of the face. |
Enums
Status
Possible face statuses.
| Name | Number | Description |
|---|---|---|
STATUS_UNSPECIFIED | 0 | Unspecified status. |
STATUS_LOADING | 1 | The face is loading. |
STATUS_READY | 2 | The face is ready. |
Services
FaceService
GetMetadata
| Method | GetMetadata |
|---|---|
| Request | GetMetadataRequest |
| Response | GetMetadataResponse |
| Description | Returns the metadata of the face. |
GetPostSchema
| Method | GetPostSchema |
|---|---|
| Request | GetPostSchemaRequest |
| Response | GetPostSchemaResponse |
| Description | Returns the schema of a post. |
GetStatus
| Method | GetStatus |
|---|---|
| Request | GetStatusRequest |
| Response | GetStatusResponse |
| Description | Returns the status of the face. |
WatchStatus
| Method | WatchStatus |
|---|---|
| Request | WatchStatusRequest |
| Response | WatchStatusResponse stream |
| Description | Returns an infinite stream of status updates. |
GetConfigSchema
| Method | GetConfigSchema |
|---|---|
| Request | GetConfigSchemaRequest |
| Response | GetConfigSchemaResponse |
| Description | Returns the schema of the face config. |
GetConfig
| Method | GetConfig |
|---|---|
| Request | GetConfigRequest |
| Response | GetConfigResponse |
| Description | Returns the config of the face. |
WatchConfig
| Method | WatchConfig |
|---|---|
| Request | WatchConfigRequest |
| Response | WatchConfigResponse stream |
| Description | Returns an infinite stream of config updates. |
SetConfig
| Method | SetConfig |
|---|---|
| Request | SetConfigRequest |
| Response | SetConfigResponse |
| Description | Sets the config of the face. |
Post
| Method | Post |
|---|---|
| Request | PostRequest |
| Response | PostResponse |
| Description | Posts a post. |
Score
| Method | Score |
|---|---|
| Request | ScoreRequest |
| Response | ScoreResponse |
| Description | Evaluates a post. |
Scrap
| Method | Scrap |
|---|---|
| Request | ScrapRequest |
| Response | ScrapResponse stream |
| Description | Scrapes posts. |
Reset
| Method | Reset |
|---|---|
| Request | ResetRequest |
| Response | ResetResponse |
| Description | Resets the face. |
Save
| Method | Save |
|---|---|
| Request | SaveRequest |
| Response | SaveResponse |
| Description | Saves the face. |