coder · aslilac · Aug 2, 2024 · Jul 12, 2024 · Jul 18, 2024 · Jul 18, 2024
diff --git a/site/e2e/expectUrl.ts b/site/e2e/expectUrl.ts
@@ -23,7 +23,12 @@ export const expectUrl = expect.extend({
       pass,
       actual,
       expected,
-      message: () => "The page does not have the expected URL pathname.",
+      message: () =>
+        "The page does not have the expected URL pathname.\n" +
+        `Expected: ${this.isNot ? "not" : ""}${this.utils.printExpected(
+          expected,
+        )}\n` +
+        `Actual: ${this.utils.printReceived(actual)}`,
     };
   },
 });
diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -516,73 +516,97 @@ class ApiMethods {
     return response.data;
   };
 
+  /**
+   * @param organization Can be the organization's ID or name
+   */
   updateOrganization = async (
-    organizationId: string,
+    organization: string,
     params: TypesGen.UpdateOrganizationRequest,
   ) => {
     const response = await this.axios.patch<TypesGen.Organization>(
-      `/api/v2/organizations/${organizationId}`,
+      `/api/v2/organizations/${organization}`,
       params,
     );
     return response.data;
   };
 
-  deleteOrganization = async (organizationId: string) => {
+  /**
+   * @param organization Can be the organization's ID or name
+   */
+  deleteOrganization = async (organization: string) => {
     await this.axios.delete<TypesGen.Organization>(
-      `/api/v2/organizations/${organizationId}`,
+      `/api/v2/organizations/${organization}`,
     );
   };
 
+  /**
+   * @param organization Can be the organization's ID or name
+   */
   getOrganization = async (
-    organizationId: string,
+    organization: string,
   ): Promise<TypesGen.Organization> => {
     const response = await this.axios.get<TypesGen.Organization>(
-      `/api/v2/organizations/${organizationId}`,
+      `/api/v2/organizations/${organization}`,
     );
 
     return response.data;
   };
 
-  getOrganizationMembers = async (organizationId: string) => {
+  /**
+   * @param organization Can be the organization's ID or name
+   */
+  getOrganizationMembers = async (organization: string) => {
     const response = await this.axios.get<
       TypesGen.OrganizationMemberWithUserData[]
-    >(`/api/v2/organizations/${organizationId}/members`);
+    >(`/api/v2/organizations/${organization}/members`);
 
     return response.data;
   };
 
-  getOrganizationRoles = async (organizationId: string) => {
+  /**
+   * @param organization Can be the organization's ID or name
+   */
+  getOrganizationRoles = async (organization: string) => {
     const response = await this.axios.get<TypesGen.AssignableRoles[]>(
-      `/api/v2/organizations/${organizationId}/members/roles`,
+      `/api/v2/organizations/${organization}/members/roles`,
     );
 
     return response.data;
   };
 
+  /**
+   * @param organization Can be the organization's ID or name
+   */
   updateOrganizationMemberRoles = async (
-    organizationId: string,
+    organization: string,
     userId: string,
     roles: TypesGen.SlimRole["name"][],
   ): Promise<TypesGen.User> => {
     const response = await this.axios.put<TypesGen.User>(
-      `/api/v2/organizations/${organizationId}/members/${userId}/roles`,
+      `/api/v2/organizations/${organization}/members/${userId}/roles`,
       { roles },
     );
 
     return response.data;
   };
 
-  addOrganizationMember = async (organizationId: string, userId: string) => {
+  /**
+   * @param organization Can be the organization's ID or name
+   */
+  addOrganizationMember = async (organization: string, userId: string) => {
     const response = await this.axios.post<TypesGen.OrganizationMember>(
-      `/api/v2/organizations/${organizationId}/members/${userId}`,
+      `/api/v2/organizations/${organization}/members/${userId}`,
     );
 
     return response.data;
   };
 
-  removeOrganizationMember = async (organizationId: string, userId: string) => {
+  /**
+   * @param organization Can be the organization's ID or name
+   */
+  removeOrganizationMember = async (organization: string, userId: string) => {
     await this.axios.delete(
-      `/api/v2/organizations/${organizationId}/members/${userId}`,
+      `/api/v2/organizations/${organization}/members/${userId}`,
     );
   };
 
@@ -601,8 +625,11 @@ class ApiMethods {
     return response.data;
   };
 
+  /**
+   * @param organization Can be the organization's ID or name
+   */
   getTemplates = async (
-    organizationId: string,
+    organization: string,
     options?: TemplateOptions,
   ): Promise<TypesGen.Template[]> => {
     const params: Record<string, string> = {};
@@ -614,19 +641,22 @@ class ApiMethods {
     }
 
     const response = await this.axios.get<TypesGen.Template[]>(
-      `/api/v2/organizations/${organizationId}/templates`,
+      `/api/v2/organizations/${organization}/templates`,
       { params },
     );
 
     return response.data;
   };
 
+  /**
+   * @param organization Can be the organization's ID or name
+   */
   getTemplateByName = async (
-    organizationId: string,
+    organization: string,
     name: string,
   ): Promise<TypesGen.Template> => {
     const response = await this.axios.get<TypesGen.Template>(
-      `/api/v2/organizations/${organizationId}/templates/${name}`,
+      `/api/v2/organizations/${organization}/templates/${name}`,
     );
 
     return response.data;
@@ -675,26 +705,32 @@ class ApiMethods {
     return response.data;
   };
 
+  /**
+   * @param organization Can be the organization's ID or name
+   */
   getTemplateVersionByName = async (
-    organizationId: string,
+    organization: string,
     templateName: string,
     versionName: string,
   ): Promise<TypesGen.TemplateVersion> => {
     const response = await this.axios.get<TypesGen.TemplateVersion>(
-      `/api/v2/organizations/${organizationId}/templates/${templateName}/versions/${versionName}`,
+      `/api/v2/organizations/${organization}/templates/${templateName}/versions/${versionName}`,
     );
 
     return response.data;
   };
 
+  /**
+   * @param organization Can be the organization's ID or name
+   */
   getPreviousTemplateVersionByName = async (
-    organizationId: string,
+    organization: string,
     templateName: string,
     versionName: string,
   ) => {
     try {
       const response = await this.axios.get<TypesGen.TemplateVersion>(
-        `/api/v2/organizations/${organizationId}/templates/${templateName}/versions/${versionName}/previous`,
+        `/api/v2/organizations/${organization}/templates/${templateName}/versions/${versionName}/previous`,
       );
 
       return response.data;
@@ -713,12 +749,15 @@ class ApiMethods {
     }
   };
 
+  /**
+   * @param organization Can be the organization's ID or name
+   */
   createTemplateVersion = async (
-    organizationId: string,
+    organization: string,
     data: TypesGen.CreateTemplateVersionRequest,
   ): Promise<TypesGen.TemplateVersion> => {
     const response = await this.axios.post<TypesGen.TemplateVersion>(
-      `/api/v2/organizations/${organizationId}/templateversions`,
+      `/api/v2/organizations/${organization}/templateversions`,
       data,
     );
 
@@ -744,12 +783,15 @@ class ApiMethods {
     return response.data;
   };
 
+  /**
+   * @param organization Can be the organization's ID or name
+   */
   createTemplate = async (
-    organizationId: string,
+    organization: string,
     data: TypesGen.CreateTemplateRequest,
   ): Promise<TypesGen.Template> => {
     const response = await this.axios.post(
-      `/api/v2/organizations/${organizationId}/templates`,
+      `/api/v2/organizations/${organization}/templates`,
       data,
     );
 
@@ -1480,31 +1522,40 @@ class ApiMethods {
     return response.data;
   };
 
-  getGroups = async (organizationId: string): Promise<TypesGen.Group[]> => {
+  /**
+   * @param organization Can be the organization's ID or name
+   */
+  getGroups = async (organization: string): Promise<TypesGen.Group[]> => {
     const response = await this.axios.get(
-      `/api/v2/organizations/${organizationId}/groups`,
+      `/api/v2/organizations/${organization}/groups`,
     );
 
     return response.data;
   };
 
+  /**
+   * @param organization Can be the organization's ID or name
+   */
   createGroup = async (
-    organizationId: string,
+    organization: string,
     data: TypesGen.CreateGroupRequest,
   ): Promise<TypesGen.Group> => {
     const response = await this.axios.post(
-      `/api/v2/organizations/${organizationId}/groups`,
+      `/api/v2/organizations/${organization}/groups`,
       data,
     );
     return response.data;
   };
 
+  /**
+   * @param organization Can be the organization's ID or name
+   */
   getGroup = async (
-    organizationId: string,
+    organization: string,
     groupName: string,
   ): Promise<TypesGen.Group> => {
     const response = await this.axios.get(
-      `/api/v2/organizations/${organizationId}/groups/${groupName}`,
+      `/api/v2/organizations/${organization}/groups/${groupName}`,
     );
     return response.data;
   };
@@ -1673,11 +1724,14 @@ class ApiMethods {
     return response.data;
   };
 
+  /**
+   * @param organization Can be the organization's ID or name
+   */
   getTemplateExamples = async (
-    organizationId: string,
+    organization: string,
   ): Promise<TypesGen.TemplateExample[]> => {
     const response = await this.axios.get(
-      `/api/v2/organizations/${organizationId}/templates/examples`,
+      `/api/v2/organizations/${organization}/templates/examples`,
     );
 
     return response.data;