fix: allow for one to one relationship requests - comments

snyk · Sep 3, 2024 · 95cbcff · 95cbcff
1 parent a23ecea
commit 95cbcff
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 4 deletions.
diff --git a/src/rulesets/rest/2022-05-25/json-api-rules/__tests__/resource-object-rules.test.ts b/src/rulesets/rest/2022-05-25/json-api-rules/__tests__/resource-object-rules.test.ts
@@ -128,6 +128,56 @@ describe("resource object rules", () => {
       },
     );
 
+    test.each(["uuid", "uri", "ulid"])(
+      "passes when PATCH request body for a relationship is of the correct form (data is an collection of resource objects with id and type)",
+      async (format) => {
+        const afterJson = {
+          ...baseJson,
+          paths: {
+            "/api/example/relationships/example": {
+              patch: {
+                responses: {}, // not tested here
+                requestBody: {
+                  content: {
+                    "application/vnd.api+json": {
+                      schema: {
+                        type: "object",
+                        properties: {
+                          data: {
+                            type: "array",
+                            items: {
+                              type: "object",
+                              properties: {
+                                type: {
+                                  type: "string",
+                                },
+                                id: {
+                                  type: "string",
+                                  format: format,
+                                },
+                              },
+                            },
+                          },
+                        },
+                      },
+                    },
+                  },
+                },
+              },
+            },
+          },
+        } as OpenAPIV3.Document;
+        const ruleRunner = new RuleRunner([resourceObjectRules]);
+        const ruleInputs = {
+          ...TestHelpers.createRuleInputs(baseJson, afterJson),
+          context,
+        };
+        const results = await ruleRunner.runRulesWithFacts(ruleInputs);
+        expect(results.length).toBeGreaterThan(0);
+        expect(results.every((result) => result.passed)).toBe(true);
+      },
+    );
+
     test.each(["uuid", "uri", "ulid"])(
       "passes when PATCH request body for a relationship is of the correct form (data is a single resource object with id and type)",
       async (format) => {

diff --git a/src/rulesets/rest/2022-05-25/json-api-rules/resource-object-rules.ts b/src/rulesets/rest/2022-05-25/json-api-rules/resource-object-rules.ts
@@ -121,7 +121,7 @@ const requestDataForPost = new RequestRule({
   },
 });
 
-// Relationship POST, PATCH, and DELETE requests must have
+// Relationship POST, PATCH, and DELETE requests can have
 // a request body with resource objects for the relationships
 // to be added/patched/deleted.
 const matchRelationshipModificationRequestArrayData = {
@@ -142,9 +142,9 @@ const matchRelationshipModificationRequestArrayData = {
   },
 };
 
-// Relationship POST, PATCH, and DELETE requests must have
-// a request body with resource objects for the relationships
-// to be added/patched/deleted.
+// Relationship POST, PATCH, and DELETE requests can have
+// a request body with a resource object for the single relationship
+// to be added (set)/patched/deleted.
 const matchRelationshipModificationRequestSingleData = {
   data: {
     type: "object",