Delete project item for user | Sample

3 parameters

project_numberintegerrequired

The project's number.

usernamestringrequired

The handle for the GitHub user account.

item_idintegerrequired

The unique identifier of the project item.

3 status codes

204Response

401Requires authentication

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 401 is returned: Requires authentication. A 403 is returned: Forbidden.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.items.delete({
  username: "octocat",
  projectNumber: "example",
  itemId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Was this helpful?

Request

Response

Errors