Skip to content

Commit 31517ef

Browse files
authored
[skip changelog] Add documentation for platform components of the gRPC interface (#696)
Comments added to the .proto files are included in the generated gRPC interface documentation.
1 parent a2adf31 commit 31517ef

File tree

4 files changed

+165
-55
lines changed

4 files changed

+165
-55
lines changed

rpc/commands/commands.pb.go

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rpc/commands/commands.proto

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,18 +63,26 @@ service ArduinoCore {
6363

6464
rpc Compile(CompileReq) returns (stream CompileResp);
6565

66+
// Download and install a platform and its tool dependencies.
6667
rpc PlatformInstall(PlatformInstallReq) returns (stream PlatformInstallResp);
6768

69+
// Download a platform and its tool dependencies to the `staging/packages`
70+
// subdirectory of the data directory.
6871
rpc PlatformDownload(PlatformDownloadReq) returns (stream PlatformDownloadResp);
6972

73+
// Uninstall a platform as well as its tool dependencies that are not used by
74+
// other installed platforms.
7075
rpc PlatformUninstall(PlatformUninstallReq) returns (stream PlatformUninstallResp);
7176

77+
// Upgrade an installed platform to the latest version.
7278
rpc PlatformUpgrade(PlatformUpgradeReq) returns (stream PlatformUpgradeResp);
7379

7480
rpc Upload(UploadReq) returns (stream UploadResp);
7581

82+
// Search for a platform in the platforms indexes.
7683
rpc PlatformSearch(PlatformSearchReq) returns (PlatformSearchResp);
7784

85+
// List all installed platforms.
7886
rpc PlatformList(PlatformListReq) returns (PlatformListResp);
7987

8088
rpc LibraryDownload(LibraryDownloadReq) returns (stream LibraryDownloadResp);

rpc/commands/core.pb.go

Lines changed: 98 additions & 55 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)