Project Management

Download Spec

Create a new project
post /projects

id

string

name

string

description

string

Request

{
  "name": "Awesome Project",
  "description": "A project that is truly awesome."
}

Response

ExamplesSchema

Project created

{
  "id": "string",
  "name": "string",
  "description": "string"
}

Get project by ID
get /projects/{projectId}

projectId

string

required

Response

ExamplesSchema

A project

{
  "id": "string",
  "name": "string",
  "description": "string"
}

Update a project by ID
put /projects/{projectId}

id

string

name

string

description

string

Request

{
  "id": "string",
  "name": "string",
  "description": "string"
}

Response

ExamplesSchema

Project updated

{
  "id": "string",
  "name": "string",
  "description": "string"
}

Delete a project by ID
delete /projects/{projectId}

projectId

string

required

Response

ExamplesSchema

Project deleted

Empty response

Was this page helpful?