aboutsummaryrefslogtreecommitdiff
path: root/pb/xesite.proto
diff options
context:
space:
mode:
authorXe Iaso <me@xeiaso.net>2024-02-24 15:28:41 -0500
committerXe Iaso <me@xeiaso.net>2024-02-24 15:28:41 -0500
commit93f6421e1d4e9ce9a4bcf1a55815fed3e2cee962 (patch)
tree27edbac93b761870e1aba09b00fb044836945faf /pb/xesite.proto
parentb541840126b67a8c0fc4fd2aefbba9253ecd1b29 (diff)
downloadxesite-93f6421e1d4e9ce9a4bcf1a55815fed3e2cee962.tar.xz
xesite-93f6421e1d4e9ce9a4bcf1a55815fed3e2cee962.zip
pb: document fields correctly
Signed-off-by: Xe Iaso <me@xeiaso.net>
Diffstat (limited to 'pb/xesite.proto')
-rw-r--r--pb/xesite.proto13
1 files changed, 11 insertions, 2 deletions
diff --git a/pb/xesite.proto b/pb/xesite.proto
index e14efd3..08f089a 100644
--- a/pb/xesite.proto
+++ b/pb/xesite.proto
@@ -7,20 +7,29 @@ import "google/protobuf/timestamp.proto";
import "external/protofeed.proto";
+// Meta lets users fetch site metadata.
service Meta {
- // Metadata fetches the build metadata of the version of xesite that is currently running
+ // Metadata fetches the build metadata of the version of xesite that is
+ // currently running.
rpc Metadata(google.protobuf.Empty) returns (BuildInfo);
}
+// BuildInfo contains metadata about a build of the site.
message BuildInfo {
+ // The commit of Xe/site that was built
string commit = 1;
+ // When the site was last rebuilt
google.protobuf.Timestamp build_time = 2;
+ // The version of Go running on the server
string go_version = 3;
+ // The version of Deno used to build the site
string deno_version = 4;
+ // The version of the xesite binary
string xesite_version = 5;
}
+// Feed lets users fetch the current feed of posts.
service Feed {
- // Get fetches the current feed of posts
+ // Get fetches the current feed of posts.
rpc Get(google.protobuf.Empty) returns (xeiaso.net.protofeed.Feed);
} \ No newline at end of file