Skip to main content

Function: updateProject()

updateProject(client, props): Promise<{ id: number; name: string; description: string; visibility: "PRIVATE" | "PUBLIC"; createdAt: string; updatedAt: string; orgId: number; orgName: string; }>

Updates a project's metadata.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ orgName: string; projectName: string; } = updateProjectParamsSchema

Path parameters (orgName, projectName)

params.orgName​

string = orgNameSchema

params.projectName​

string = projectNameSchema

body​

{ name?: string; description?: string; visibility?: "PRIVATE" | "PUBLIC"; orgName?: string; } = updateProjectBodySchema

Request body with fields to update

body.name?​

string = ...

body.description?​

string = ...

body.visibility?​

"PRIVATE" | "PUBLIC" = ...

body.orgName?​

string = ...

Returns​

Promise<{ id: number; name: string; description: string; visibility: "PRIVATE" | "PUBLIC"; createdAt: string; updatedAt: string; orgId: number; orgName: string; }>

Promise resolving to the updated project

Operation Id​

update-project

Example​

const project = await updateProject(client, {
  params: { orgName: 'my-org', projectName: 'my-project' },
  body: { description: 'Updated description' }
});