Projects

Available from @codespar/sdk 0.12.0; the version on npm is 0.12.0. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check fails the build.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import {  } from "@codespar/sdk";

const  = new ({ : .. });

GET `/v1/projects`

GET/v1/projects

List projects

const  = await ..("/v1/projects");

Parameters, body and every documented response: GET /v1/projects in the HTTP reference.

POST `/v1/projects`

POST/v1/projects

Create a project

const  = await ..("/v1/projects", {
  : {
    : "Example",
    : "example",
    : "live",
    : {}
  }
});

Parameters, body and every documented response: POST /v1/projects in the HTTP reference.

GET `/v1/projects/{id}`

GET/v1/projects/{id}

Read one project

const  = await ..("/v1/projects/{id}", {
  : {
    : "prj_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/projects/{id} in the HTTP reference.

PATCH `/v1/projects/{id}`

PATCH/v1/projects/{id}

Rename a project, change its slug, or promote it to default

const  = await ..("/v1/projects/{id}", {
  : {
    : "prj_0000000000000000"
  },
  : {
    : "Example",
    : "example",
    : true
  }
});

Parameters, body and every documented response: PATCH /v1/projects/{id} in the HTTP reference.

DELETE `/v1/projects/{id}`

DELETE/v1/projects/{id}

Delete a project

const  = await ..("/v1/projects/{id}", {
  : {
    : "prj_0000000000000000"
  }
});

Parameters, body and every documented response: DELETE /v1/projects/{id} in the HTTP reference.

GET `/v1/projects/{id}/settings`

GET/v1/projects/{id}/settings

Read a project's effective settings

const  = await ..("/v1/projects/{id}/settings", {
  : {
    : "prj_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/projects/{id}/settings in the HTTP reference.

PATCH `/v1/projects/{id}/settings`

PATCH/v1/projects/{id}/settings

Set or reset a project's settings

const  = await ..("/v1/projects/{id}/settings", {
  : {
    : "prj_0000000000000000"
  },
  : {
    : {}
  }
});

Parameters, body and every documented response: PATCH /v1/projects/{id}/settings in the HTTP reference.

GET `/v1/projects/{id}/settings/history`

GET/v1/projects/{id}/settings/history

Read a project's settings audit log

const  = await ..("/v1/projects/{id}/settings/history", {
  : {
    : "prj_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/projects/{id}/settings/history in the HTTP reference.

Projects

On this page