.do
ApiQuality

BugReport

A documented defect or issue discovered during testing or production use, including reproduction steps, severity, and tracking information.

BugReport

A documented defect or issue discovered during testing or production use, including reproduction steps, severity, and tracking information.

Properties

  • id (string): Unique identifier for the bug report.
  • title (string): Brief title summarizing the bug.
  • description (string): Detailed description of the bug and its impact.
  • severity (string): Severity level (blocker, critical, major, minor, trivial).
  • priority (string): Priority for fixing (critical, high, medium, low).
  • status (string): Current status (new, open, in_progress, resolved, closed, reopened, duplicate, wont_fix).
  • type (string): Type of bug (functional, performance, security, ui, data, regression).
  • environment (string): Environment where bug was found (development, staging, production).
  • reproducibility (string): How often bug occurs (always, sometimes, rarely, unable_to_reproduce).
  • stepsToReproduce (string[]): Ordered steps to reproduce the bug.
  • expectedBehavior (string): What should happen.
  • actualBehavior (string): What actually happens.
  • testCase ([[TestCase]]): Test case that discovered the bug.
  • testRun ([[TestRun]]): Test run where bug was discovered.
  • build ([[Build]]): Build version where bug exists.
  • commit ([[Commit]]): Git commit where bug was introduced.
  • affectedVersion (string): Product version where bug exists.
  • fixedVersion (string): Product version where bug was fixed.
  • reporter ([[User]]): User who reported the bug.
  • assignee ([[User]]): User assigned to fix the bug.
  • created (number): Unix timestamp when bug was reported.
  • updated (number): Unix timestamp when bug was last updated.
  • resolved (number): Unix timestamp when bug was resolved.
  • resolution (string): How bug was resolved (fixed, duplicate, wont_fix, cannot_reproduce, by_design).
  • screenshots (string[]): URLs to screenshots showing the bug.
  • videos (string[]): URLs to videos demonstrating the bug.
  • logs (string): Error logs or stack traces.
  • attachments (string[]): URLs to related files or documents.
  • tags (string[]): Tags for categorizing and filtering bugs.
  • duplicateOf ([[BugReport]]): Reference to original bug if this is a duplicate.
  • relatedBugs ([[BugReport]][]): Related or similar bug reports.
  • metadata (object): Set of key-value pairs for storing additional information.

Actions

create

Create a new bug report.

Input: [[BugReport]]
Output: [[BugReport]]

update

Update bug report details or status.

Input: [[BugReport]]
Output: [[BugReport]]

assign

Assign the bug to a user for resolution.

Input: [[User]]
Output: [[BugReport]]

resolve

Mark the bug as resolved.

Input: [[BugReport]]
Output: [[BugReport]]

reopen

Reopen a resolved bug.

Input: [[BugReport]]
Output: [[BugReport]]

close

Close the bug report.

Input: [[BugReport]]
Output: [[BugReport]]

duplicate

Mark as duplicate of another bug.

Input: [[BugReport]]
Output: [[BugReport]]

verify

Verify the bug fix.

Input: [[BugReport]]
Output: [[BugReport]]

comment

Add a comment to the bug report.

Input: string
Output: [[BugReport]]

Events

  • created: Triggered when a new bug is reported.
  • updated: Triggered when bug details are modified.
  • assigned: Triggered when bug is assigned to a user.
  • resolved: Triggered when bug is marked as resolved.
  • reopened: Triggered when resolved bug is reopened.
  • closed: Triggered when bug is closed.
  • verified: Triggered when bug fix is verified.
  • commented: Triggered when a comment is added.