[#119] Edit docs and README

serokell · Aug 2, 2022 · 6bd6412 · 6bd6412
1 parent 13fa4f7
commit 6bd6412
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -26,6 +26,7 @@ Available commands:
                            returning only the specified field for each entry
   create                   Create a new entry at the specified path
   set-field                Set a field on the entry at the specified path
+  set-field-visibility     Set a field's visibility on the entry at the specified path
   delete-field             Delete a field from the entry at the specified path
   find                     Find and list entries, optionally filtering
   rename                   Rename an entry or directory

diff --git a/app/cli/Main.hs b/app/cli/Main.hs
@@ -88,7 +88,6 @@ main = do
           res@SFREntryNotFound{} -> printError $ buildSetFieldResult CLI res
           res@SFRSuccess{} -> printSuccess $ buildSetFieldResult CLI res
 
-
       SomeCommand cmd@CmdSetFieldVisibility{} -> do
         runCommand config cmd >>= \case
           res@SFVREntryNotFound{} -> printError $ buildSetFieldVisibilityResult CLI res

diff --git a/docs/web-api-error-codes.md b/docs/web-api-error-codes.md
@@ -9,7 +9,8 @@
 These codes are grouped in the following way:
 - `view` errors: 100-102
 - `create` errors: 200-202
-- `set-field` errors: 300-301
+- `set-field` errors: 300
+- `set-field-visibility` errors: 350-351
 - `delete-field` errors: 400-401
 - `rename`/`copy` errors: 500-505
 - `delete` errors: 600-601
@@ -37,7 +38,12 @@ See the following tables for detailed explanations of error codes.
 | Error                  | Code |
 |:-----------------------|:----:|
 | Entry not found        | 300  |
-| Missing field contents | 301  |
+
+## Set-field-visibility
+| Error                  | Code |
+|:-----------------------|:----:|
+| Entry not found        | 350  |
+| Field not found        | 351  |
 
 ## Delete-field
 | Error           | Code |

diff --git a/lib/Backend/Commands.hs b/lib/Backend/Commands.hs
@@ -150,7 +150,7 @@ setFieldCmd
       updateOrInsertField nowUtc
 
     updateOrInsertField :: UTCTime -> Maybe Field -> Field
-    updateOrInsertField nowUtc fieldMb = case fieldMb of
+    updateOrInsertField nowUtc = \case
       Nothing ->
         -- The field does not yet exist, insert a new one.
         newField nowUtc fieldContents

diff --git a/lib/Web/Server.hs b/lib/Web/Server.hs
@@ -74,9 +74,9 @@ handleSetFieldVisibilityResult :: SetFieldVisibilityResult -> Handler Entry
 handleSetFieldVisibilityResult = \case
   SFVRSuccess _ qEntry -> pure $ qpPath qEntry
   res@SFVREntryNotFound{} ->
-    throwCofferServerError err404 300 (pretty res)
+    throwCofferServerError err404 350 (pretty res)
   res@SFVRFieldNotFound{} ->
-    throwCofferServerError err404 301 (pretty res)
+    throwCofferServerError err404 351 (pretty res)
   where
     pretty = resultToText buildSetFieldVisibilityResult