Update documentation for deleted parameter in names and structures endpoints

src/main/java/org/openepics/names/rest/api/v1/INames.java

@@ -206,8 +206,8 @@ public interface INames {
      * Find valid names (search).
      * Return paged list of name elements.
      *
-     * @param deleted if deleted-only names are to be included
-     * (false for non-deleted-only names, true for deleted-only names, not used for both cases)
+     * @param deleted if deleted names are to be selected or not, omitted for both deleted and non-deleted names
+     * (true for deleted names, false for non-deleted names, omitted for both deleted and non-deleted names)
      * @param name name
      * @param systemStructure system structure mnemonic path
      * @param deviceStructure device structure mnemonic path
@@ -256,7 +256,7 @@ public interface INames {
     @GetMapping(
             produces = {"application/json"})
     public ResponsePageNameElements readNames(
-            @Parameter(in = ParameterIn.QUERY, description = "if deleted names are to be included or not, omitted for both deleted and not deleted names") @RequestParam(required = false) Boolean deleted,
+            @Parameter(in = ParameterIn.QUERY, description = "if deleted names are to be selected or not, omitted for both deleted and non-deleted names") @RequestParam(required = false) Boolean deleted,
             @Parameter(in = ParameterIn.QUERY, description = "search by name") @RequestParam(required = false) String name,
             @Parameter(in = ParameterIn.QUERY, description = "search by system structure mnemonic path") @RequestParam(required = false) String systemStructure,
             @Parameter(in = ParameterIn.QUERY, description = "search by device structure mnemonic path") @RequestParam(required = false) String deviceStructure,

src/main/java/org/openepics/names/rest/api/v1/IStructures.java

@@ -215,8 +215,8 @@ public interface IStructures {
      *
      * @param type type of structure
      * @param statuses statuses for structures
-     * @param deleted if deleted-only structures are to be included
-     * (false for non-deleted-only structures, true for deleted-only structures, not used for both cases)
+     * @param deleted if deleted structures are to be selected or not, omitted for both deleted and non-deleted structures
+     * (true for deleted structures, false for non-deleted structures, omitted for both deleted and non-deleted structures)
      * @param parent parent uuid
      * @param name name
      * @param mnemonic mnemonic
@@ -268,7 +268,7 @@ public interface IStructures {
     public ResponsePageStructureElements readStructures(
             @Parameter(in = ParameterIn.PATH,  description = "search by type of structure") @PathVariable("type") Type type,
             @Parameter(in = ParameterIn.QUERY, description = "search by statuses") @RequestParam(required = false) Status[] statuses,
-            @Parameter(in = ParameterIn.QUERY, description = "if deleted structures are to be included or not, omitted for both deleted and not deleted structures") @RequestParam(required = false) Boolean deleted,
+            @Parameter(in = ParameterIn.QUERY, description = "if deleted structures are to be selected or not, omitted for both deleted and not deleted structures") @RequestParam(required = false) Boolean deleted,
             @Parameter(in = ParameterIn.QUERY, description = "search by parent uuid") @RequestParam(required = false) String parent,
             @Parameter(in = ParameterIn.QUERY, description = "search by name") @RequestParam(required = false) String name,
             @Parameter(in = ParameterIn.QUERY, description = "search by mnemonic") @RequestParam(required = false) String mnemonic,
@@ -342,8 +342,8 @@ public interface IStructures {
      *
      * @param uuid uuid
      * @param statuses statuses for structures
-     * @param deleted if deleted-only structures are to be included
-     * (false for non-deleted-only structures, true for deleted-only structures, not used for both cases)
+     * @param deleted if deleted structures are to be selected or not, omitted for both deleted and non-deleted structures
+     * (true for deleted structures, false for non-deleted structures, omitted for both deleted and non-deleted structures)
      * @param orderBy order by field
      * @param isAsc sort order, ascending or descending
      * @param page page starting from 0, offset
@@ -389,7 +389,7 @@ public interface IStructures {
     public ResponsePageStructureElements readStructuresChildren(
             @Parameter(in = ParameterIn.PATH,  description = "find by uuid") @PathVariable("uuid") String uuid,
             @Parameter(in = ParameterIn.QUERY, description = "search by statuses") @RequestParam(required = false) Status[] statuses,
-            @Parameter(in = ParameterIn.QUERY, description = "if deleted structures are to be included or not, omitted for both deleted and not deleted structures", required = false) @RequestParam(required = false) Boolean deleted,
+            @Parameter(in = ParameterIn.QUERY, description = "if deleted structures are to be selected or not, omitted for both deleted and not deleted structures", required = false) @RequestParam(required = false) Boolean deleted,
             @Parameter(in = ParameterIn.QUERY, description = "order by field") @RequestParam(required = false) FieldStructure orderBy,
             @Parameter(in = ParameterIn.QUERY, description = "sort order, ascending or descending") @RequestParam(required = false) Boolean isAsc,
             @Parameter(in = ParameterIn.QUERY, description = "page starting from 0, offset") @RequestParam(required = false, defaultValue = DEFAULT_PAGE) Integer page,