doc

Author: hexaforce

server/Makefile

@@ -119,6 +119,12 @@ grpc:
       --go-grpc_out=./internal/adapter/internalapi/ --go-grpc_opt=paths=source_relative  \
         ./schemas/internalapi/v1/schema.proto
 
+grpc-doc:
+	protoc -I . \
+	  --doc_out=schemas/internalapi/docs \
+	  --doc_opt=markdown,schema.md \
+	  schemas/internalapi/v1/schema.proto
+
 # =======================
 # Tools
 # =======================

server/schemas/internalapi/docs/schema.md

@@ -211,9 +211,9 @@ Core Project messages
 | Name | Number | Description |
 | ---- | ------ | ----------- |
 | PUBLISHMENT_STATUS_UNSPECIFIED | 0 |  |
-| PUBLISHMENT_STATUS_PUBLIC | 1 |  |
-| PUBLISHMENT_STATUS_LIMITED | 2 |  |
-| PUBLISHMENT_STATUS_PRIVATE | 3 |  |
+| PUBLISHMENT_STATUS_PUBLIC | 1 | The project is published and publicly accessible. |
+| PUBLISHMENT_STATUS_LIMITED | 2 | The project is published with limited access. |
+| PUBLISHMENT_STATUS_PRIVATE | 3 | The project is unpublished (web files have been deleted). |
 
 
 
@@ -241,10 +241,10 @@ Core Project messages
 
 | Method Name | Request Type | Response Type | Description |
 | ----------- | ------------ | ------------- | ------------|
-| GetProjectList | [GetProjectListRequest](#reearth-visualizer-v1-GetProjectListRequest) | [GetProjectListResponse](#reearth-visualizer-v1-GetProjectListResponse) | aaaaaaaaa |
-| GetProject | [GetProjectRequest](#reearth-visualizer-v1-GetProjectRequest) | [GetProjectResponse](#reearth-visualizer-v1-GetProjectResponse) |  |
-| CreateProject | [CreateProjectRequest](#reearth-visualizer-v1-CreateProjectRequest) | [CreateProjectResponse](#reearth-visualizer-v1-CreateProjectResponse) |  |
-| DeleteProject | [DeleteProjectRequest](#reearth-visualizer-v1-DeleteProjectRequest) | [DeleteProjectResponse](#reearth-visualizer-v1-DeleteProjectResponse) |  |
+| GetProjectList | [GetProjectListRequest](#reearth-visualizer-v1-GetProjectListRequest) | [GetProjectListResponse](#reearth-visualizer-v1-GetProjectListResponse) | Retrieves the list of projects the user can access. Request headers: user-id: <User ID> |
+| GetProject | [GetProjectRequest](#reearth-visualizer-v1-GetProjectRequest) | [GetProjectResponse](#reearth-visualizer-v1-GetProjectResponse) | Retrieves a specific project regardless of authentication. Request headers: user-id: <User ID> |
+| CreateProject | [CreateProjectRequest](#reearth-visualizer-v1-CreateProjectRequest) | [CreateProjectResponse](#reearth-visualizer-v1-CreateProjectResponse) | Creates a new project in the specified team. Request headers: user-id: <User ID> |
+| DeleteProject | [DeleteProjectRequest](#reearth-visualizer-v1-DeleteProjectRequest) | [DeleteProjectResponse](#reearth-visualizer-v1-DeleteProjectResponse) | Deletes a project. Request headers: user-id: <User ID> |
 
 
 

server/schemas/internalapi/v1/schema.proto

@@ -7,9 +7,20 @@ import "google/protobuf/timestamp.proto";
 option go_package = "proto/v1";
 
 service ReEarthVisualizer {
+  // Retrieves the list of projects the user can access.
+  // Request headers: user-id: <User ID>
   rpc GetProjectList(GetProjectListRequest) returns (GetProjectListResponse) {}
+
+  // Retrieves a specific project regardless of authentication.
+  // Request headers: user-id: <User ID>
   rpc GetProject(GetProjectRequest) returns (GetProjectResponse) {}
+
+  // Creates a new project in the specified team.
+  // Request headers: user-id: <User ID>
   rpc CreateProject(CreateProjectRequest) returns (CreateProjectResponse) {}
+
+  // Deletes a project.
+  // Request headers: user-id: <User ID>
   rpc DeleteProject(DeleteProjectRequest) returns (DeleteProjectResponse) {}
 }
 
@@ -91,10 +102,17 @@ enum Visualizer {
 
 enum PublishmentStatus {
   PUBLISHMENT_STATUS_UNSPECIFIED = 0;
+
+  // The project is published and publicly accessible.
   PUBLISHMENT_STATUS_PUBLIC = 1;
+
+  // The project is published with limited access.
   PUBLISHMENT_STATUS_LIMITED = 2;
+
+  // The project is unpublished (web files have been deleted).
   PUBLISHMENT_STATUS_PRIVATE = 3;
 }
+
 // Returns projects visible to the user.
 // If the user does not belong to the team, only projects with "public"
 // visibility are returned. If the user is a member of the team, all projects