GitHub Projects data contract | PatchOps Knowledge

Provenance

PublisherGitHub Projects

API basehttps://api.github.com/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (OAuth)

Methods (15)

listProjects

read

List project boards for a user or organization owner.

Input schema

{
  "type": "object",
  "properties": {
    "owner": {
      "type": "string"
    },
    "ownerType": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "organization"
          ]
        },
        {
          "type": "string",
          "enum": [
            "user"
          ]
        },
        {
          "type": "string",
          "enum": [
            "org"
          ]
        }
      ]
    },
    "first": {
      "type": "number"
    },
    "after": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

getProject

read

Retrieve a single project board by number or project id.

Input schema

{
  "type": "object",
  "properties": {
    "owner": {
      "type": "string"
    },
    "projectNumber": {
      "type": "number"
    },
    "projectId": {
      "type": "string"
    },
    "ownerType": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "organization"
          ]
        },
        {
          "type": "string",
          "enum": [
            "user"
          ]
        },
        {
          "type": "string",
          "enum": [
            "org"
          ]
        }
      ]
    }
  },
  "additionalProperties": false
}

createProject

write

Create a new project board with title and optional repository link.

Input schema

{
  "type": "object",
  "properties": {
    "ownerId": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "repositoryId": {
      "type": "string"
    },
    "shortDescription": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "ownerId",
    "title"
  ]
}

updateProject

write

Update a project board title, description, readme, closed, or public flag.

Input schema

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "shortDescription": {
      "type": "string"
    },
    "readme": {
      "type": "string"
    },
    "closed": {
      "type": "boolean"
    },
    "public": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "projectId"
  ]
}

deleteProject

write

Delete a project board permanently by project id.

Input schema

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "projectId"
  ]
}

listProjectItems

read

List items on a project board, including issues, pull requests, and drafts.

Input schema

{
  "type": "object",
  "properties": {
    "owner": {
      "type": "string"
    },
    "projectNumber": {
      "type": "number"
    },
    "projectId": {
      "type": "string"
    },
    "ownerType": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "organization"
          ]
        },
        {
          "type": "string",
          "enum": [
            "user"
          ]
        },
        {
          "type": "string",
          "enum": [
            "org"
          ]
        }
      ]
    },
    "first": {
      "type": "number"
    },
    "after": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

addItemToProject

write

Add an existing issue or pull request to a project board.

Input schema

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string"
    },
    "contentId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "projectId",
    "contentId"
  ]
}

createDraftIssue

write

Create a draft issue on a project board with title and body.

Input schema

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "body": {
      "type": "string"
    },
    "assigneeIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "projectId",
    "title"
  ]
}

updateProjectItem

write

Update a project item field value on a project board.

Input schema

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string"
    },
    "itemId": {
      "type": "string"
    },
    "fieldId": {
      "type": "string"
    },
    "value": {}
  },
  "additionalProperties": false,
  "required": [
    "projectId",
    "itemId",
    "fieldId",
    "value"
  ]
}

removeItemFromProject

write

Remove an item from a project board by item id.

Input schema

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string"
    },
    "itemId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "projectId",
    "itemId"
  ]
}

listProjectFields

read

List custom fields defined on a project board.

Input schema

{
  "type": "object",
  "properties": {
    "owner": {
      "type": "string"
    },
    "projectNumber": {
      "type": "number"
    },
    "projectId": {
      "type": "string"
    },
    "ownerType": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "organization"
          ]
        },
        {
          "type": "string",
          "enum": [
            "user"
          ]
        },
        {
          "type": "string",
          "enum": [
            "org"
          ]
        }
      ]
    },
    "first": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

createProjectField

write

Create a project field with a name, data type, and optional single-select options.

Input schema

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "dataType": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "TEXT"
          ]
        },
        {
          "type": "string",
          "enum": [
            "NUMBER"
          ]
        },
        {
          "type": "string",
          "enum": [
            "DATE"
          ]
        },
        {
          "type": "string",
          "enum": [
            "SINGLE_SELECT"
          ]
        },
        {
          "type": "string",
          "enum": [
            "ITERATION"
          ]
        }
      ]
    },
    "singleSelectOptions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "color": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "projectId",
    "name",
    "dataType"
  ]
}

updateProjectField

write

Update a project field name using its field identifier.

Input schema

{
  "type": "object",
  "properties": {
    "fieldId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "fieldId"
  ]
}

listProjectViews

read

List project views for an owner or project, filtered by project number and owner type.

Input schema

{
  "type": "object",
  "properties": {
    "owner": {
      "type": "string"
    },
    "projectNumber": {
      "type": "number"
    },
    "projectId": {
      "type": "string"
    },
    "ownerType": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "organization"
          ]
        },
        {
          "type": "string",
          "enum": [
            "user"
          ]
        },
        {
          "type": "string",
          "enum": [
            "org"
          ]
        }
      ]
    },
    "first": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

getProjectView

read

Retrieve one project view by view identifier or owner and view number.

Input schema

{
  "type": "object",
  "properties": {
    "owner": {
      "type": "string"
    },
    "projectNumber": {
      "type": "number"
    },
    "viewNumber": {
      "type": "number"
    },
    "viewId": {
      "type": "string"
    },
    "ownerType": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "organization"
          ]
        },
        {
          "type": "string",
          "enum": [
            "user"
          ]
        },
        {
          "type": "string",
          "enum": [
            "org"
          ]
        }
      ]
    }
  },
  "additionalProperties": false
}