Code Collaboration

Create a new code collaboration session

post /projects/{projectId}/collaborations

Initiates a new code collaboration session for a project, allowing developers to work together in a shared development environment.

id

string

projectId

string

participants

array[string]

active

boolean

creationDate

string

date-time

Request

{
  "participants": [
    "dev1",
    "dev2",
    "dev3"
  ]
}

Response

ExamplesSchema

Code collaboration session created

{
  "id": "c123",
  "projectId": "p456",
  "participants": [
    "dev1",
    "dev2",
    "dev3"
  ],
  "active": true,
  "creationDate": "2023-07-24T18:00:00Z"
}

Get a code collaboration session by ID

get /projects/{projectId}/collaborations/{collaborationId}

Retrieves information about a specific code collaboration session.

projectId

string

required

collaborationId

string

required

Response

ExamplesSchema

A code collaboration session

{
  "id": "c123",
  "projectId": "p456",
  "participants": [
    "dev1",
    "dev2",
    "dev3"
  ],
  "active": true,
  "creationDate": "2023-07-24T18:00:00Z"
}

Update a code collaboration session by ID

put /projects/{projectId}/collaborations/{collaborationId}

Updates the participants of a code collaboration session, adding or removing developers as needed.

id

string

projectId

string

participants

array[string]

active

boolean

creationDate

string

date-time

Request

{
  "participants": [
    "dev1",
    "dev4"
  ]
}

Response

ExamplesSchema

Code collaboration session updated

{
  "id": "c123",
  "projectId": "p456",
  "participants": [
    "dev1",
    "dev4"
  ],
  "active": true,
  "creationDate": "2023-07-24T18:00:00Z"
}

Delete a code collaboration session by ID

delete /projects/{projectId}/collaborations/{collaborationId}

Ends a specific code collaboration session.

projectId

string

required

collaborationId

string

required

Response

ExamplesSchema

Collaboration session ended

Empty response