project

Update Project

Changed on

Update a project's basic information (name and/or description).

Args: project_id: UUID of the project (validated to be owned by current user) project_data: Project update parameters containing optional name/description project_service: Project service for business logic

Returns: Response with success status, message, and updated project data

Raises: HTTPException: 404 if project not found or user doesn't own it ValueError: If no fields to update are provided

put/api/v1/project/{project_id}

Request

  • Base URL
    https://api.maia-analytics.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.maia-analytics.com/api/v1/project/{project_id}
  • Auth
    HTTP bearer

Request body

namestring nullable

New name for the project

descriptionstring nullable

New description for the project

visibility'private' | 'workspace_read' | 'workspace_write'

User-facing visibility options for updating project visibility.

Separate from ProjectVisibility to:

  • Prevent setting visibility to 'example' via the API
  • Map 'private' to None (NULL) in the database

Response

Successful Response

successboolean required
messagestring required

Changes

  • 73f618ba0a7eRevision changes
    • info

      added the required property // to the response with the status