From 1ff3d004cfe3b2d8e843a5dbd217f8b24f496122 Mon Sep 17 00:00:00 2001 From: Mark Paluch Date: Thu, 16 Nov 2017 12:19:55 +0100 Subject: [PATCH] Polishing. Improve Javadoc. See gh-177. --- .../springframework/vault/core/VaultOperations.java | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/spring-vault-core/src/main/java/org/springframework/vault/core/VaultOperations.java b/spring-vault-core/src/main/java/org/springframework/vault/core/VaultOperations.java index 21dd9c1e..d487d91b 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/core/VaultOperations.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/core/VaultOperations.java @@ -81,8 +81,8 @@ public interface VaultOperations { VaultPkiOperations opsForPki(String path); /** - * Read from a secret backend. Reading data using this method is suitable for secret - * backends that do not require a request body. + * Read from a Vault path. Reading data using this method is suitable for API + * calls/secret backends that do not require a request body. * * @param path must not be {@literal null}. * @return the data. May be {@literal null} if the path does not exist. @@ -100,7 +100,7 @@ public interface VaultOperations { VaultResponseSupport read(String path, Class responseType); /** - * Enumerate keys from a secret backend. + * Enumerate keys from a Vault path. * * @param path must not be {@literal null}. * @return the data. May be {@literal null} if the path does not exist. @@ -108,16 +108,16 @@ public interface VaultOperations { List list(String path); /** - * Write to a secret backend. + * Write to a Vault path. * * @param path must not be {@literal null}. * @param body the body, may be {@literal null} if absent. - * @return the configuration data. May be empty but never {@literal null}. + * @return the response, may be empty but never {@literal null}. */ VaultResponse write(String path, Object body); /** - * Delete a path in the secret backend. + * Delete a path. * * @param path must not be {@literal null}. */