api: stream: allow name update (#2323)

* api: stream: allow name update

* tests

* add name to field type check

* update test

packages/api/src/controllers/stream.test.ts

@@ -1240,6 +1240,15 @@ describe("controllers/stream", () => {
         });
       });
 
+      it("should allow patch of name", async () => {
+        const res = await client.patch(patchPath, {
+          name: "new name",
+        });
+        expect(res.status).toBe(204);
+        let s = await db.stream.get(stream.id);
+        expect(s.name).toBe("new name");
+      });
+
       it("should allow patch of playbackPolicy", async () => {
         const res = await client.patch(patchPath, {
           playbackPolicy: {
@@ -1257,15 +1266,6 @@ describe("controllers/stream", () => {
         expect(res.status).toBe(400);
       });
 
-      it("should disallow additional fields", async () => {
-        const res = await client.patch(patchPath, {
-          name: "the stream name is immutable",
-        });
-        expect(res.status).toBe(422);
-        const json = await res.json();
-        expect(json.errors[0]).toContain("additionalProperties");
-      });
-
       it("should disallow adding recordingSpec without record=true", async () => {
         const res = await client.patch(patchPath, {
           recordingSpec: { profiles: [{ bitrate: 1600000 }] },
@@ -1309,6 +1309,7 @@ describe("controllers/stream", () => {
           multistream: { targets: { profile: "a", id: "b" } },
         });
         await testTypeErr({ multistream: { targets: [{ profile: 123 }] } });
+        await testTypeErr({ name: 123 });
       });
 
       it("should validate url format", async () => {

packages/api/src/controllers/stream.ts

@@ -1961,6 +1961,7 @@ app.patch(
       creatorId,
       profiles,
       recordingSpec,
+      name,
     } = payload;
     if (record != undefined && stream.isActive && stream.record != record) {
       res.status(400);
@@ -1977,6 +1978,7 @@ app.patch(
 
     let patch: StreamPatchPayload & Partial<DBStream> = {
       record,
+      name,
       profiles,
       suspended,
       creatorId: mapInputCreatorId(creatorId),

packages/api/src/schema/api-schema.yaml

@@ -768,6 +768,8 @@ components:
           $ref: "#/components/schemas/new-stream-payload/properties/recordingSpec"
         userTags:
           $ref: "#/components/schemas/stream/properties/userTags"
+        name:
+          $ref: "#/components/schemas/stream/properties/name"
     target-add-payload:
       type: object
       additionalProperties: false