Delete

client.projects.brief.delete(, ?): BriefDeleteResponse { deleted }

DELETE/projects/{projectId}/brief

Delete the project’s Quality Gate brief

ParametersExpand Collapse

projectID: string

ReturnsExpand Collapse

BriefDeleteResponse { deleted }

deleted: boolean

Delete

import Scenario from '@scenario-labs/sdk';

const client = new Scenario({
  apiKey: process.env['SCENARIO_SDK_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SCENARIO_SDK_API_SECRET'], // This is the default and can be omitted
});

const brief = await client.projects.brief.delete('projectId');

console.log(brief.deleted);

{
  "deleted": true
}

Returns Examples

{
  "deleted": true
}