tweaks to docs (#200)

This commit is contained in:
Dominic Wong
2021-09-02 15:23:24 +01:00
committed by GitHub
parent 2e5af32faf
commit d378ef2de5
39 changed files with 83 additions and 88 deletions

View File

@@ -1,5 +1,5 @@
Store, list and retrieve text files
Store, list, and retrieve text files
# File Service
Save, list and retrieve text files by project and path.
Save, list, and retrieve text files. Files can have a path in the same way they would on your computer e.g.`/documents/text-files/file.txt`. Files can optionally be grouped in to projects.

View File

@@ -56,12 +56,12 @@ message SaveRequest {
message SaveResponse {
}
// List file by their project and optionally a path.
// List files by their project and optionally a path.
message ListRequest {
// Project, required for listing.
string project = 1;
// Defaults to '/', ie. lists all files in a project.
// Supply path if of a folder if you want to list
// Supply path to a folder if you want to list
// files inside that folder
// eg. '/docs'
string path = 2;