issuetracker / API / API Resources

API Resources

A generic issue-tracking API normally exposes the following resource model.

1 min readApplies to v0.6.0
On this page ▾
  1. Project
  2. Issue
  3. Comments
  4. Membership
text
Project
  │
  ├── Project members
  │
  └── Issues
        │
        ├── status
        ├── priority
        ├── assignee
        ├── reporter
        ├── labels
        ├── comments
        └── attachments

Project

Represents the workspace/container in which issues are managed.

Typical operations:

text
create
retrieve
update
list
archive/delete

Issue

Represents an actionable work item.

Typical operations:

text
create
retrieve
update
list
assign
change status
change priority
comment

Comments

Comments belong to an issue and provide an auditable discussion trail.

Membership

Membership controls which users can access a project and which project-level actions they can perform.