Merge pull request #346 from nspcc-dev/new-status-codes

Author: carpawell

object/service.proto

@@ -64,6 +64,9 @@ service ObjectService {
   // Statuses:
   // - **OK** (0, SECTION_SUCCESS): \
   //   object has been successfully saved in the container;
+  // - **INCOMPLETE** (1, SECTION_SUCCESS): \
+  //   object was put to some nodes, but the number of replicas is not sufficient
+  //   to satisfy placement policy;
   // - Common failures (SECTION_FAILURE_COMMON);
   // - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
   //   write access to the container is denied;
@@ -99,6 +102,9 @@ service ObjectService {
   // Statuses:
   // - **OK** (0, SECTION_SUCCESS): \
   //   object has been successfully marked to be removed from the container;
+  // - **INCOMPLETE** (1, SECTION_SUCCESS): \
+  //   some nodes have accepted the deletion mark, but some may still store
+  //   the object;
   // - Common failures (SECTION_FAILURE_COMMON);
   // - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
   //   delete access to the object is denied;
@@ -153,6 +159,9 @@ service ObjectService {
   // Statuses:
   // - **OK** (0, SECTION_SUCCESS): \
   //   objects have been successfully selected;
+  // - **INCOMPLETE** (1, SECTION_SUCCESS): \
+  //   some nodes were unable to process the request, so the result may
+  //   not contain all data;
   // - Common failures (SECTION_FAILURE_COMMON);
   // - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
   //   access to operation SEARCH of the object is denied;

proto-docs/status.md

@@ -90,6 +90,8 @@ Section of failed statuses independent of the operation.
 | WRONG_MAGIC_NUMBER | 1 | [**1025**] Wrong magic of the NeoFS network. Details: - [**0**] Magic number of the served NeoFS network (big-endian 64-bit unsigned integer). |
 | SIGNATURE_VERIFICATION_FAIL | 2 | [**1026**] Signature verification failure. |
 | NODE_UNDER_MAINTENANCE | 3 | [**1027**] Node is under maintenance. |
+| BAD_REQUEST | 4 | [**1028**] Malformed, syntactically or semantically incorrect request, client-side error. |
+| BUSY | 5 | [**1029**] Some node resources are exhausted and request can't be processed. This is likely to be a transient state and request can be retried in future. |
 
 
 
@@ -157,6 +159,7 @@ Section of NeoFS successful return codes.
 | Name | Number | Description |
 | ---- | ------ | ----------- |
 | OK | 0 | [**0**] Default success. Not detailed. If the server cannot match successful outcome to the code, it should use this code. |
+| INCOMPLETE | 1 | [**1**] Incomplete success, only a part of the request done which may or may not be sufficient for the client. Examples are object PUT making 2 out of 3 required replicas or distributed SEARCH getting result from 4 out of 5 nodes. |
 
 
  <!-- end enums -->

status/types.proto

@@ -81,6 +81,12 @@ enum Success {
   // If the server cannot match successful outcome to the code, it should
   // use this code.
   OK = 0;
+
+  // [**1**] Incomplete success, only a part of the request done which may
+  // or may not be sufficient for the client. Examples are object PUT making
+  // 2 out of 3 required replicas or distributed SEARCH getting result from
+  // 4 out of 5 nodes.
+  INCOMPLETE = 1;
 }
 
 // Section of failed statuses independent of the operation.
@@ -101,6 +107,15 @@ enum CommonFail {
 
   // [**1027**] Node is under maintenance.
   NODE_UNDER_MAINTENANCE = 3;
+
+  // [**1028**] Malformed, syntactically or semantically incorrect request,
+  // client-side error.
+  BAD_REQUEST = 4;
+
+  // [**1029**] Some node resources are exhausted and request can't be
+  // processed. This is likely to be a transient state and request can be
+  // retried in future.
+  BUSY = 5;
 }
 
 // Section of statuses for object-related operations.