Merge pull request #7747 from schrodingersket/feature/7665

Account Management API: Added v2 API endpoint add collaborators…

Author: williamstein

src/packages/next/lib/api/schema/projects/collaborators/add.ts

@@ -0,0 +1,27 @@
+import { z } from "../../../framework";
+
+import { FailedAPIOperationSchema, OkAPIOperationSchema } from "../../common";
+
+import { ProjectIdSchema } from "../common";
+import { AccountIdSchema } from "../../accounts/common";
+
+// OpenAPI spec
+//
+export const AddProjectCollaboratorInputSchema = z
+  .object({
+    project_id: ProjectIdSchema,
+    account_id: AccountIdSchema,
+  })
+  .describe("Add a collaborator to an existing project.");
+
+export const AddProjectCollaboratorOutputSchema = z.union([
+  FailedAPIOperationSchema,
+  OkAPIOperationSchema,
+]);
+
+export type AddProjectCollaboratorInput = z.infer<
+  typeof AddProjectCollaboratorInputSchema
+>;
+export type AddProjectCollaboratorOutput = z.infer<
+  typeof AddProjectCollaboratorOutputSchema
+>;

src/packages/next/lib/api/schema/projects/collaborators/remove.ts

@@ -0,0 +1,25 @@
+import { z } from "../../../framework";
+
+import { FailedAPIOperationSchema, OkAPIOperationSchema } from "../../common";
+
+import { ProjectIdSchema } from "../common";
+
+// OpenAPI spec
+//
+export const RemoveProjectCollaboratorInputSchema = z
+  .object({
+    project_id: ProjectIdSchema,
+  })
+  .describe("Remove a collaborator from a project.");
+
+export const RemoveProjectCollaboratorOutputSchema = z.union([
+  FailedAPIOperationSchema,
+  OkAPIOperationSchema,
+]);
+
+export type RemoveProjectCollaboratorInput = z.infer<
+  typeof RemoveProjectCollaboratorInputSchema
+>;
+export type RemoveProjectCollaboratorOutput = z.infer<
+  typeof RemoveProjectCollaboratorOutputSchema
+>;

src/packages/next/pages/api/v2/index.ts

@@ -64,5 +64,11 @@ export default docsApiRoute({
     title: "CoCalc API",
     description: "",
     logoUrl: "https://cocalc.com/_next/static/media/full.0a70e50d.svg",
+    ogConfig: {
+      title: "CoCalc HTTP API (v2)",
+      type: "website",
+      url: "https://cocalc.com/api/v2",
+      imageUrl: "https://cocalc.com/webapp/favicon.ico",
+    },
   },
 });

src/packages/next/pages/api/v2/projects/collaborators/add.ts

@@ -0,0 +1,61 @@
+/*
+API endpoint to add a user to an existing project.
+
+Permissions checks are performed by the underlying API call and are NOT
+executed at this stage.
+
+*/
+import { db } from "@cocalc/database";
+import { add_collaborators_to_projects } from "@cocalc/server/projects/collab";
+
+import getAccountId from "lib/account/get-account";
+import getParams from "lib/api/get-params";
+import { apiRoute, apiRouteOperation } from "lib/api";
+import { OkStatus } from "lib/api/status";
+import {
+  AddProjectCollaboratorInputSchema,
+  AddProjectCollaboratorOutputSchema,
+} from "lib/api/schema/projects/collaborators/add";
+
+async function handle(req, res) {
+  const { project_id, account_id } = getParams(req);
+  const client_account_id = await getAccountId(req);
+
+  try {
+    if (!client_account_id) {
+      throw Error("must be signed in");
+    }
+
+    await add_collaborators_to_projects(
+      db(),
+      client_account_id,
+      [account_id],
+      [project_id],
+    );
+
+    res.json(OkStatus);
+  } catch (err) {
+    res.json({ error: err.message });
+  }
+}
+
+export default apiRoute({
+  add: apiRouteOperation({
+    method: "POST",
+    openApiOperation: {
+      tags: ["Projects", "Administrators"],
+    },
+  })
+    .input({
+      contentType: "application/json",
+      body: AddProjectCollaboratorInputSchema,
+    })
+    .outputs([
+      {
+        status: 200,
+        contentType: "application/json",
+        body: AddProjectCollaboratorOutputSchema,
+      },
+    ])
+    .handler(handle),
+});