From e94455e60813cb7a744fad3300e0be0cfc76049d Mon Sep 17 00:00:00 2001 From: Brian Kassouf Date: Tue, 15 Feb 2022 11:00:48 -0800 Subject: [PATCH] Improve code comments on logical.Paths object (#14080) * Improve code comments on logical.Paths object * Update sdk/logical/logical.go Co-authored-by: Nick Cabatoff Co-authored-by: Nick Cabatoff --- sdk/logical/logical.go | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/sdk/logical/logical.go b/sdk/logical/logical.go index 94b52abf1..fb9619ae2 100644 --- a/sdk/logical/logical.go +++ b/sdk/logical/logical.go @@ -112,18 +112,19 @@ type Factory func(context.Context, *BackendConfig) (Backend, error) // Paths is the structure of special paths that is used for SpecialPaths. type Paths struct { - // Root are the paths that require a root token to access + // Root are the API paths that require a root token to access Root []string - // Unauthenticated are the paths that can be accessed without any auth. + // Unauthenticated are the API paths that can be accessed without any auth. // These can't be regular expressions, it is either exact match, a prefix // match and/or a wildcard match. For prefix match, append '*' as a suffix. // For a wildcard match, use '+' in the segment to match any identifier // (e.g. 'foo/+/bar'). Note that '+' can't be adjacent to a non-slash. Unauthenticated []string - // LocalStorage are paths (prefixes) that are local to this instance; this - // indicates that these paths should not be replicated + // LocalStorage are storage paths (prefixes) that are local to this cluster; + // this indicates that these paths should not be replicated across performance clusters + // (DR replication is unaffected). LocalStorage []string // SealWrapStorage are storage paths that, when using a capable seal,