stig-core/com.stigway.review

Package-level declarations

Types

data class AutomatedReviewFinding(val key: String, val ruleId: String, val severity: String, val message: String, val remediation: String = "", val subjectId: String = "", val category: String = "", val task: String = "")

Immutable evidence at first response, not the issue's current workflow state.

ReviewAction

data class ReviewAction(val id: String, val label: String, val needsIssue: Boolean = false)

ReviewComment

data class ReviewComment(val id: String, val author: String, val text: String, val createdAt: String, val url: String)

ReviewConnection

data class ReviewConnection(val projectId: String, val issueRepository: String, val issueLabel: String, val provider: String = "github", val apiUrl: String = "https://api.github.com", val webUrl: String = "https://github.com")

No credentials or machine-local paths belong in the shared connection contract.

ReviewFinding

data class ReviewFinding(val record: ReviewRecord, val ref: ReviewThreadRef, val url: String, val state: String, val stateReason: String? = null, val author: String, val createdAt: String = "", val updatedAt: String = "", val assignees: List<String> = emptyList(), val labels: List<String> = emptyList(), val permissions: ReviewPermissions = ReviewPermissions())

ReviewIdentity

object ReviewIdentity

Kotlin owns durable identities; report URLs, array positions and revisions are occurrence evidence only.

ReviewPermissions

data class ReviewPermissions(val comment: Boolean = false, val changeState: Boolean = false, val classify: Boolean = false)

ReviewProvider

interface ReviewProvider

Synchronous provider boundary; IO runs outside read actions and the UI thread. actions uses cached permissions.

ReviewProviderException

class ReviewProviderException(message: String, val retryAfterSeconds: Long = 60, val operationRejected: Boolean = false) : RuntimeException

Redacted provider failure. Only a definite rejection permits a new write attempt without reconciliation.

ReviewRecord

data class ReviewRecord(val schema: Int = 2, val id: String, val projectId: String, val anchorType: String = "object", val kind: String = "question", val title: String, val message: String, val report: ReviewReport, val target: ReviewTarget, val source: ReviewSource = ReviewSource(), val automatic: AutomatedReviewFinding? = null, val annotation: Map<String, Any?>? = null, val pullRequest: Map<String, Any?>? = null)

Portable issue metadata. Version 1 remains readable; version 2 adds ticketless automated findings.

ReviewReport

data class ReviewReport(val revision: String = "", val url: String)

ReviewSource

data class ReviewSource(val repository: String = "", val repositoryUrl: String = "", val revision: String = "", val renderedRevision: String = "", val path: String = "", val startLine: Int? = null, val endLine: Int? = null, val githubUrl: String = "", val ideaUrl: String = "", val contentHash: String = "")

ReviewTarget

data class ReviewTarget(val key: String, val entityId: String = "", val property: String = "", val reference: String = "", val kotlinReference: String = "", val workProductId: String = "", val moduleId: String = "", val viewpoint: String = "", val reportFragment: String = "#", val contentHash: String = "", val authors: List<String> = emptyList(), val relativeSelector: ReviewTextSelector? = null)

Finding identity and model/source location are independent: a subjectId need not be an entityId.

ReviewTextSelector

data class ReviewTextSelector(val quote: String, val start: Int, val end: Int, val prefix: String? = null, val suffix: String? = null)

ReviewThreadRef

data class ReviewThreadRef(val provider: String, val host: String, val project: String, val itemId: String)

ReviewUser

data class ReviewUser(val login: String, val name: String = "")

UnimplementedReviewProvider

class UnimplementedReviewProvider(val connection: ReviewConnection) : ReviewProvider

Future backends deliberately fail rather than advertising partially working review workflows.