Skip to content

[skip changelog] Add documentation for library components of the gRPC interface #692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 18, 2020
Merged

[skip changelog] Add documentation for library components of the gRPC interface #692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3e30567
[skip changelog] Add documentation for library components of the gRPC…
per1234 May 7, 2020
5b3ebb3
Correct documentation re: relative vs absolute paths provided by Libr…
per1234 Jun 11, 2020
a5a91fb
Use preferred "platform" term in gRPC interface documentation
per1234 Jun 11, 2020
aa1f252
Fix formatting of gRPC interface documentation
per1234 Jun 11, 2020
5798918
Fix incorrect documentation for task_progress field of LibraryUninsta…
per1234 Jun 11, 2020
80f4934
Document that library version is the key of the releases map
per1234 Jun 11, 2020
5e5e431
Update gRPC interface code comments
per1234 Jun 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions rpc/commands/commands.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions rpc/commands/commands.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,18 +91,27 @@ service ArduinoCore {
// List all installed platforms.
rpc PlatformList(PlatformListReq) returns (PlatformListResp);

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

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

// Uninstall an Arduino library.
rpc LibraryUninstall(LibraryUninstallReq) returns (stream LibraryUninstallResp);

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

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

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

// List the installed libraries.
rpc LibraryList(LibraryListReq) returns (LibraryListResp);
}

Expand Down
Loading