Edit Project

PUT 
/api/v1/project/:projectIdentifier

Edit Project

Request

Path Parameters

projectIdentifier stringrequired

Project identifier (ID or name)

application/json

Body

required

name string

Unique identifier for the project (slug)

projectName string

Human-friendly name of the project (not unique)

description string
platforms string[]
label string

Label name to assign to the project

projectType string

Possible values: [product, formation]

Responses

200

application/json

Schema

Schema

id numberrequired

Unique identifier of the project

name stringrequired

Unique slug name of the project

projectName string

Human-friendly name of the project (not unique)

description string
projectType stringrequired

Possible values: [product, formation]

status string

Status of the project (active, completed, on-hold)

label string

Label name assigned to the project

owner stringrequired

Owner of the project

platforms string[]

Platforms supported by the project

numMembers number

Number of members in the project

versions numberrequired

Number of versions available for the project

memberContext

object

role stringrequired

Possible values: [project-owner, project-admin, project-member]

preferences

object

required

pinned boolean

summary

object

latestRelease

object

Latest release of the project

id stringrequired

version stringrequired

name string

requiredRegulationsCount numberrequired

compliantRegulationsCount numberrequired

upcomingRelease

object

Upcoming release of the project

id stringrequired

version stringrequired

name string

requiredRegulationsCount numberrequired

compliantRegulationsCount numberrequired

Example (from schema)

{
  "id": 0,
  "name": "string",
  "projectName": "string",
  "description": "string",
  "projectType": "product",
  "status": "string",
  "label": "string",
  "owner": "string",
  "platforms": [
    "string"
  ],
  "numMembers": 0,
  "versions": 5,
  "memberContext": {
    "role": "project-owner",
    "preferences": {
      "pinned": true
    }
  },
  "summary": {
    "latestRelease": {
      "id": "string",
      "version": "string",
      "name": "string",
      "requiredRegulationsCount": 0,
      "compliantRegulationsCount": 0
    },
    "upcomingRelease": {
      "id": "string",
      "version": "string",
      "name": "string",
      "requiredRegulationsCount": 0,
      "compliantRegulationsCount": 0
    }
  }
}

Loading...