Skip to content

Commit b95230c

Browse files
committed
doc
1 parent 4de0209 commit b95230c

File tree

3 files changed

+31
-7
lines changed

3 files changed

+31
-7
lines changed

server/Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,12 @@ grpc:
119119
--go-grpc_out=./internal/adapter/internalapi/ --go-grpc_opt=paths=source_relative \
120120
./schemas/internalapi/v1/schema.proto
121121

122+
grpc-doc:
123+
protoc -I . \
124+
--doc_out=schemas/internalapi/docs \
125+
--doc_opt=markdown,schema.md \
126+
schemas/internalapi/v1/schema.proto
127+
122128
# =======================
123129
# Tools
124130
# =======================

server/schemas/internalapi/docs/schema.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -211,9 +211,9 @@ Core Project messages
211211
| Name | Number | Description |
212212
| ---- | ------ | ----------- |
213213
| PUBLISHMENT_STATUS_UNSPECIFIED | 0 | |
214-
| PUBLISHMENT_STATUS_PUBLIC | 1 | |
215-
| PUBLISHMENT_STATUS_LIMITED | 2 | |
216-
| PUBLISHMENT_STATUS_PRIVATE | 3 | |
214+
| PUBLISHMENT_STATUS_PUBLIC | 1 | The project is published and publicly accessible. |
215+
| PUBLISHMENT_STATUS_LIMITED | 2 | The project is published with limited access. |
216+
| PUBLISHMENT_STATUS_PRIVATE | 3 | The project is unpublished (web files have been deleted). |
217217

218218

219219

@@ -241,10 +241,10 @@ Core Project messages
241241

242242
| Method Name | Request Type | Response Type | Description |
243243
| ----------- | ------------ | ------------- | ------------|
244-
| GetProjectList | [GetProjectListRequest](#reearth-visualizer-v1-GetProjectListRequest) | [GetProjectListResponse](#reearth-visualizer-v1-GetProjectListResponse) | aaaaaaaaa |
245-
| GetProject | [GetProjectRequest](#reearth-visualizer-v1-GetProjectRequest) | [GetProjectResponse](#reearth-visualizer-v1-GetProjectResponse) | |
246-
| CreateProject | [CreateProjectRequest](#reearth-visualizer-v1-CreateProjectRequest) | [CreateProjectResponse](#reearth-visualizer-v1-CreateProjectResponse) | |
247-
| DeleteProject | [DeleteProjectRequest](#reearth-visualizer-v1-DeleteProjectRequest) | [DeleteProjectResponse](#reearth-visualizer-v1-DeleteProjectResponse) | |
244+
| 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> |
245+
| GetProject | [GetProjectRequest](#reearth-visualizer-v1-GetProjectRequest) | [GetProjectResponse](#reearth-visualizer-v1-GetProjectResponse) | Retrieves a specific project regardless of authentication. Request headers: user-id: <User ID> |
246+
| 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> |
247+
| DeleteProject | [DeleteProjectRequest](#reearth-visualizer-v1-DeleteProjectRequest) | [DeleteProjectResponse](#reearth-visualizer-v1-DeleteProjectResponse) | Deletes a project. Request headers: user-id: <User ID> |
248248

249249

250250

server/schemas/internalapi/v1/schema.proto

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,20 @@ import "google/protobuf/timestamp.proto";
77
option go_package = "proto/v1";
88

99
service ReEarthVisualizer {
10+
// Retrieves the list of projects the user can access.
11+
// Request headers: user-id: <User ID>
1012
rpc GetProjectList(GetProjectListRequest) returns (GetProjectListResponse) {}
13+
14+
// Retrieves a specific project regardless of authentication.
15+
// Request headers: user-id: <User ID>
1116
rpc GetProject(GetProjectRequest) returns (GetProjectResponse) {}
17+
18+
// Creates a new project in the specified team.
19+
// Request headers: user-id: <User ID>
1220
rpc CreateProject(CreateProjectRequest) returns (CreateProjectResponse) {}
21+
22+
// Deletes a project.
23+
// Request headers: user-id: <User ID>
1324
rpc DeleteProject(DeleteProjectRequest) returns (DeleteProjectResponse) {}
1425
}
1526

@@ -91,10 +102,17 @@ enum Visualizer {
91102

92103
enum PublishmentStatus {
93104
PUBLISHMENT_STATUS_UNSPECIFIED = 0;
105+
106+
// The project is published and publicly accessible.
94107
PUBLISHMENT_STATUS_PUBLIC = 1;
108+
109+
// The project is published with limited access.
95110
PUBLISHMENT_STATUS_LIMITED = 2;
111+
112+
// The project is unpublished (web files have been deleted).
96113
PUBLISHMENT_STATUS_PRIVATE = 3;
97114
}
115+
98116
// Returns projects visible to the user.
99117
// If the user does not belong to the team, only projects with "public"
100118
// visibility are returned. If the user is a member of the team, all projects

0 commit comments

Comments
 (0)