Function: getProject()

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

Gets project information by org and project names.

Parameters

client

ApiClient

The API client instance

props

The request properties

params

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

Path parameters (orgName, projectName)

params.orgName

string = orgNameSchema

params.projectName

string = projectNameSchema

Returns

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

Promise resolving to the project information

Operation Id

get-project

Example

const project = await getProject(client, {
  params: { orgName: 'my-org', projectName: 'my-project' }
});