[MODORDERS-1209]. Improved field names

folio-org · Nov 28, 2024 · 1756dce · 1756dce
1 parent 2f23a32
commit 1756dce
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/mod-orders/examples/claimingCollection.sample b/mod-orders/examples/claimingCollection.sample
@@ -1,5 +1,5 @@
 {
-  "claiming": [
+  "claimingPieceIds": [
     "123e4567-e89b-12d3-a456-426614174000",
     "123e4567-e89b-12d3-a456-426614174001"
   ],

diff --git a/mod-orders/examples/claimingResults.sample b/mod-orders/examples/claimingResults.sample
@@ -1,12 +1,12 @@
 {
-  "claimingResults": [
+  "claimingPieceResults": [
     {
       "pieceId": "123e4567-e89b-12d3-a456-426614174000",
-      "type": "success"
+      "status": "success"
     },
     {
       "pieceId": "123e4567-e89b-12d3-a456-426614174001",
-      "type": "failure",
+      "status": "failure",
       "error": {
         "code": "CLAIM_ERROR",
         "message": "Failed to claim piece"

diff --git a/mod-orders/schemas/claimingCollection.json b/mod-orders/schemas/claimingCollection.json
@@ -3,9 +3,9 @@
   "description": "A collection of claiming pieces",
   "type": "object",
   "properties": {
-    "claiming": {
+    "claimingPieceIds": {
       "description": "List of claiming pieces",
-      "id": "claiming",
+      "id": "claimingPieceIds",
       "type": "array",
       "items": {
         "description": "The id of the piece",
@@ -20,7 +20,7 @@
   },
   "additionalProperties": false,
   "required": [
-    "claiming",
+    "claimingPieceIds",
     "totalRecords"
   ]
 }
diff --git a/mod-orders/schemas/claimingResults.json b/mod-orders/schemas/claimingResults.json
@@ -3,9 +3,9 @@
   "description": "A collection of claiming results",
   "type": "object",
   "properties": {
-    "claimingResults": {
+    "claimingPieceResults": {
       "description": "List of claiming results",
-      "id": "claimingResults",
+      "id": "claimingPieceResults",
       "type": "array",
       "items": {
         "type": "object",
@@ -15,7 +15,7 @@
             "type": "string",
             "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
           },
-          "type": {
+          "status": {
             "description": "Resulting status of the processed piece record",
             "type": "string",
             "enum": [
@@ -43,7 +43,7 @@
   },
   "additionalProperties": false,
   "required": [
-    "claimingResults",
+    "claimingPieceResults",
     "totalRecords"
   ]
 }