minor documentation updates

vinogradoff · Jan 10, 2022 · 8b4d09e · 8b4d09e
1 parent 9e9a6b9
commit 8b4d09e
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/main/java/io/github/vinogradoff/testdatabroker/TestDataController.java b/src/main/java/io/github/vinogradoff/testdatabroker/TestDataController.java
@@ -13,7 +13,7 @@
 
 @RestController
 @RequestMapping("/api")
-@Api(value = "Managing test data", description = "Managing test data")
+@Api(value = "Managing test data", description = "Managing test data: a dataset can contain multiple values under a given key.")
 public class TestDataController {
 
     @Autowired
@@ -29,7 +29,7 @@ public void saveData(@PathVariable @ApiParam(value = "dataset", example = "mySer
                                  String dataset,
                          @PathVariable @ApiParam(value = "key", example = "active user", required = true)
                                  String key,
-                         @RequestParam @ApiParam(value = "value", example = "demo@acme.com", required = true)
+                         @RequestParam @ApiParam(value = "value to be added under the key", example = "demo@acme.com", required = true)
                                  String value) {
         var actualDict = repo.getOrDefault(dataset, new HashMap<>());
         var actualValue = actualDict.getOrDefault(key, new ArrayList<>());