feat: No reference fields in Open Booking API responses

openactive · Jul 21, 2022 · daa318c · daa318c
1 parent 9dbc899
commit daa318c
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 4 deletions.
diff --git a/versions/2.x/models/ScheduledSession.json b/versions/2.x/models/ScheduledSession.json
@@ -38,8 +38,8 @@
     "BRequest": "request",
     "BResponse": "response",
     "BResponseOrderItemError": "response",
-    "OrdersFeed": "response",
-    "OrderProposalsFeed": "response",
+    "OrdersFeed": "ordersFeed",
+    "OrderProposalsFeed": "ordersFeed",
     "OrderStatus": "response",
     "TestInterface": "testInterface"
   },
@@ -127,6 +127,22 @@
       "shallNotBeReferencedFields": [
         "superEvent"
       ]
+    },
+    "ordersFeed": {
+      "requiredFields": [
+        "type",
+        "id",
+        "startDate",
+        "superEvent"
+      ],
+      "recommendedFields": [
+        "eventStatus",
+        "maximumAttendeeCapacity",
+        "remainingAttendeeCapacity"
+      ],
+      "shallNotInclude": [
+        "offers"
+      ]
     }
   },
   "fields": {

diff --git a/versions/2.x/models/Slot.json b/versions/2.x/models/Slot.json
@@ -28,8 +28,8 @@
     "BRequest": "request",
     "BResponse": "response",
     "BResponseOrderItemError": "response",
-    "OrdersFeed": "response",
-    "OrderProposalsFeed": "response",
+    "OrdersFeed": "ordersFeed",
+    "OrderProposalsFeed": "ordersFeed",
     "OrderStatus": "response",
     "TestInterface": "request"
   },
@@ -119,6 +119,23 @@
       "shallNotBeReferencedFields": [
         "facilityUse"
       ]
+    },
+    "ordersFeed": {
+      "requiredFields": [
+        "type",
+        "id",
+        "startDate",
+        "facilityUse"
+      ],
+      "recommendedFields": [
+        "endDate",
+        "duration",
+        "maximumUses",
+        "remainingUses"
+      ],
+      "shallNotInclude": [
+        "offers"
+      ]
     }
   },
   "inSpec": [