Skip to content

Commit daf0878

Browse files
per1234Roberto Sora
authored andcommitted
[skip changelog] Add documentation for library components of the gRPC interface (arduino#692)
* [skip changelog] Add documentation for library components of the gRPC interface Comments added to the .proto files are included in the generated gRPC interface documentation. * Correct documentation re: relative vs absolute paths provided by Library message fields Co-authored-by: Roberto Sora <r.sora@arduino.cc> * Use preferred "platform" term in gRPC interface documentation The official term is now "platform", rather than the previous ambiguous "core". Co-authored-by: Roberto Sora <r.sora@arduino.cc> * Fix formatting of gRPC interface documentation * Fix incorrect documentation for task_progress field of LibraryUninstall response * Document that library version is the key of the releases map * Update gRPC interface code comments Co-authored-by: Roberto Sora <r.sora@arduino.cc>
1 parent ec44ad1 commit daf0878

File tree

4 files changed

+337
-104
lines changed

4 files changed

+337
-104
lines changed

rpc/commands/commands.pb.go

Lines changed: 18 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: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,18 +96,27 @@ service ArduinoCore {
9696
// List all installed platforms.
9797
rpc PlatformList(PlatformListReq) returns (PlatformListResp);
9898

99+
// Download the archive file of an Arduino library in the libraries index to
100+
// the staging directory.
99101
rpc LibraryDownload(LibraryDownloadReq) returns (stream LibraryDownloadResp);
100102

103+
// Download and install an Arduino library from the libraries index.
101104
rpc LibraryInstall(LibraryInstallReq) returns (stream LibraryInstallResp);
102105

106+
// Uninstall an Arduino library.
103107
rpc LibraryUninstall(LibraryUninstallReq) returns (stream LibraryUninstallResp);
104108

109+
// Upgrade all installed Arduino libraries to the newest version available.
105110
rpc LibraryUpgradeAll(LibraryUpgradeAllReq) returns (stream LibraryUpgradeAllResp);
106111

112+
// List the recursive dependencies of a library, as defined by the `depends`
113+
// field of the library.properties files.
107114
rpc LibraryResolveDependencies(LibraryResolveDependenciesReq) returns (LibraryResolveDependenciesResp);
108115

116+
// Search the Arduino libraries index for libraries.
109117
rpc LibrarySearch(LibrarySearchReq) returns (LibrarySearchResp);
110118

119+
// List the installed libraries.
111120
rpc LibraryList(LibraryListReq) returns (LibraryListResp);
112121
}
113122

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy