curl --request PATCH \
--url https://davinci-app.com/api/v2/projects/{projectId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"readme": "<string>",
"tags": [
"<string>"
],
"units": "<string>"
}
'import os
from davinci_sdk import DavinciClient
with DavinciClient(api_key=os.environ["DAVINCI_API_KEY"]) as client:
result = client.projects.update(
project_id, description="Launch vehicle upper stage"
)
print(result.metadata.description)
import { DavinciClient } from '@celedon/davinci-sdk';
const client = new DavinciClient({
apiKey: process.env.DAVINCI_API_KEY!,
});
const { metadata } = await client.projects.update(projectId, {
description: 'Launch vehicle upper stage',
});
console.log(metadata.description);
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
readme: '<string>',
tags: ['<string>'],
units: '<string>'
})
};
fetch('https://davinci-app.com/api/v2/projects/{projectId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"metadata": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"owner": "<string>",
"createdBy": "<string>",
"visibility": "<string>",
"version": "<string>",
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"storageUsedBytes": 1,
"transferState": "<string>",
"collaborators": [
"<string>"
],
"pendingCollaborators": [
"<string>"
]
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Update project metadata
Updates any subset of name, description, visibility, readme, tags, or units.
curl --request PATCH \
--url https://davinci-app.com/api/v2/projects/{projectId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"readme": "<string>",
"tags": [
"<string>"
],
"units": "<string>"
}
'import os
from davinci_sdk import DavinciClient
with DavinciClient(api_key=os.environ["DAVINCI_API_KEY"]) as client:
result = client.projects.update(
project_id, description="Launch vehicle upper stage"
)
print(result.metadata.description)
import { DavinciClient } from '@celedon/davinci-sdk';
const client = new DavinciClient({
apiKey: process.env.DAVINCI_API_KEY!,
});
const { metadata } = await client.projects.update(projectId, {
description: 'Launch vehicle upper stage',
});
console.log(metadata.description);
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
readme: '<string>',
tags: ['<string>'],
units: '<string>'
})
};
fetch('https://davinci-app.com/api/v2/projects/{projectId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"metadata": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"owner": "<string>",
"createdBy": "<string>",
"visibility": "<string>",
"version": "<string>",
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"storageUsedBytes": 1,
"transferState": "<string>",
"collaborators": [
"<string>"
],
"pendingCollaborators": [
"<string>"
]
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
Personal access token. The scopes granted at issuance determine both which
operations the key may call and the ceiling on the resource permissions it
can exercise. Each scope family is a ladder: projects:manage implies
projects:write and projects:read; cards:manage implies cards:write
and cards:read; and teams:manage implies teams:write and teams:read.
These are named API capability bundles, not blanket domain roles:
manage exposes only the permissions enumerated for that scope and never
bypasses the acting user's current role-based access.
Path Parameters
Project id. May be compound in the form {projectId}--{branchName}.
1Body
Response
Updated project metadata.
Stored project metadata. ProjectSummary is this plus the live inUse
and activeBranch fields that only the list endpoint computes.
Hide child attributes
Hide child attributes
User id or organization id that owns the project.
x >= 0User ids with effective access, including access inherited from an organization.