From 84047d4bcd21734d3f508484db2a40dbaf919c47 Mon Sep 17 00:00:00 2001 From: cvgw Date: Mon, 17 Feb 2020 11:27:19 -0800 Subject: [PATCH] add example signature for API --- docs/design_proposals/filesystem-resolution-proposal-01.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/design_proposals/filesystem-resolution-proposal-01.md b/docs/design_proposals/filesystem-resolution-proposal-01.md index 76508a24a..741bd59c7 100644 --- a/docs/design_proposals/filesystem-resolution-proposal-01.md +++ b/docs/design_proposals/filesystem-resolution-proposal-01.md @@ -72,6 +72,11 @@ The API should return only two arguments * A set of filepaths * error or nil +The signature of the API should look similar to +``` + ResolveFilePaths(inputPaths []string, whitelist []WhitelistEntry) (resolvedPaths []string, err error) +``` + The API will iterate over the set of filepaths and for each item * check whether it is whitelisted; if it is, skip it * check whether it is a symlink