Skip to main content

Lint workspace

Generated from apiome-rest/openapi.yaml (API version 1.204.1) — do not edit by hand. How to authenticate is on the REST API reference.

Tag: lint-workspace · 9 operations

POST /v1/lint/workspace/decisions/bulk​

Bulk Decision Action

Apply one decision change to up to :data:BULK_ITEM_CAP findings (CLX-4.1, #4859).

Authorized: requires lint_findings:edit; items whose transition is approval-tier (entering/leaving waived, resolving a waiver_requested row) additionally require lint_findings:publish and fail per-item without it. Audited: every applied item appends an immutable lint_finding_decision_events row (plus the standard denial audit on 403). Reversible: each result carries beforeState so the client can issue the exact inverse request; approval-tier inversions require the same publish permission.

Operation id: bulk_decision_action_v1_lint_workspace_decisions_bulk_post

Parameters

NameInTypeRequiredDescription
tenant_slugquerystringyesURL-safe tenant slug that scopes the request.
authorizationheaderstring or nullnoJWT bearer token for authenticated access (Authorization: Bearer <token>).
X-API-Keyheaderstring or nullnoTenant-scoped API key used as an alternative to JWT bearer authentication.

Request body (required)

Request body for bulk decision action.

Responses

StatusDescriptionBody
200Successful response for bulk decision action.application/json LintWorkspaceBulkDecisionResponse
422Validation Errorapplication/json HTTPValidationError

GET /v1/lint/workspace/findings​

List Workspace Findings

Cross-catalog findings queue over the latest evidence per subject (CLX-4.1, #4859).

"All new unwaived security errors" (acceptance criterion 1) is ?new=true&severity=error&axis=security&state=open; missing required coverage lives in GET /summary's coverage block. Facets are computed over the filtered, pre-pagination set so the toolbar can show counts for the current queue.

Operation id: list_workspace_findings_v1_lint_workspace_findings_get

Parameters

NameInTypeRequiredDescription
severityquerystring or nullnoCSV of error,warning,info
statequerystring or nullnoCSV of effective decision states
axisquerystring or nullnoCSV of scoring axis keys
gradequerystring or nullnoCSV of composite grades A–F
coveragequerystring or nullnomissing | met
profilequerystring or nullnoCSV of execution profiles
scannerquerystring or nullnoCSV of scanner ids (source)
subjectTypequerystring or nullnocatalog_revision | mcp_endpoint_version
projectIdquerystring or nullnoQuery parameter: project id.
ownerUserIdquerystring or nullnoQuery parameter: owner user id.
ruleIdquerystring or nullnoQuery parameter: rule id.
categoryquerystring or nullnoQuery parameter: category.
newqueryboolean or nullnoTrue restricts to regressions (new since previous run)
qquerystring or nullnoFree-text search
sortquerystring or nullnoseverity | newest | rule | subject
limitqueryintegernoMaximum number of rows to return.
offsetqueryintegernoNumber of rows to skip before returning results.
tenant_slugquerystringyesURL-safe tenant slug that scopes the request.
authorizationheaderstring or nullnoJWT bearer token for authenticated access (Authorization: Bearer <token>).
X-API-Keyheaderstring or nullnoTenant-scoped API key used as an alternative to JWT bearer authentication.

Responses

StatusDescriptionBody
200Successful response for list workspace findings.application/json LintWorkspaceFindingsResponse
422Validation Errorapplication/json HTTPValidationError

GET /v1/lint/workspace/quality-ranks​

Workspace Quality Ranks

Per-format import/export grade distribution and drift over a window (IXH-2.7, #5102).

Scores are captured per revision, but a single revision's grade cannot show that a team's imports are trending downward or that one format grades low because its adapter is incomplete. This series answers both: grades are grouped by (scope, format) and each group reports its distribution, its drift (scoreDelta — newest scored observation minus the oldest in the window), the style-guide versions that produced those grades, and the attribution split that separates adapter-attributable findings from spec-attributable ones. Export readiness ranks ride the same series, so a target whose readiness is sliding shows up beside the specs feeding it.

The window is bounded (days ≤ 180, matching the retention default) and the response describes at most 24 format groups, stating truncated when it dropped any.

Operation id: workspace_quality_ranks_v1_lint_workspace_quality_ranks_get

Parameters

NameInTypeRequiredDescription
daysqueryintegernoQuery parameter: days.
scopequerystring or nullnoimport | export (both when omitted)
stagequerystring or nullnopreflight | committed (both when omitted)
projectIdquerystring or nullnoQuery parameter: project id.
tenant_slugquerystringyesURL-safe tenant slug that scopes the request.
authorizationheaderstring or nullnoJWT bearer token for authenticated access (Authorization: Bearer <token>).
X-API-Keyheaderstring or nullnoTenant-scoped API key used as an alternative to JWT bearer authentication.

Responses

StatusDescriptionBody
200Successful response for workspace quality ranks.application/json QualityRankSeriesResponse
422Validation Errorapplication/json HTTPValidationError

GET /v1/lint/workspace/summary​

Workspace Summary

Tenant-wide posture rollup: grades, axes, coverage gaps, finding/waiver counts.

Operation id: workspace_summary_v1_lint_workspace_summary_get

Parameters

NameInTypeRequiredDescription
projectIdquerystring or nullnoQuery parameter: project id.
tenant_slugquerystringyesURL-safe tenant slug that scopes the request.
authorizationheaderstring or nullnoJWT bearer token for authenticated access (Authorization: Bearer <token>).
X-API-Keyheaderstring or nullnoTenant-scoped API key used as an alternative to JWT bearer authentication.

Responses

StatusDescriptionBody
200Successful response for workspace summary.application/json LintWorkspaceSummaryResponse
422Validation Errorapplication/json HTTPValidationError

Workspace Trends

Daily series separating genuine remediation from policy / waiver / coverage change.

remediatedFindings counts only fingerprints that disappeared from evidence and were NOT waived or false-positived; waiver grants, expiries, false-positive marks, and policy pack publications are their own series (acceptance criterion 4).

Operation id: workspace_trends_v1_lint_workspace_trends_get

Parameters

NameInTypeRequiredDescription
daysqueryintegernoQuery parameter: days.
projectIdquerystring or nullnoQuery parameter: project id.
tenant_slugquerystringyesURL-safe tenant slug that scopes the request.
authorizationheaderstring or nullnoJWT bearer token for authenticated access (Authorization: Bearer <token>).
X-API-Keyheaderstring or nullnoTenant-scoped API key used as an alternative to JWT bearer authentication.

Responses

StatusDescriptionBody
200Successful response for workspace trends.application/json LintWorkspaceTrendsResponse
422Validation Errorapplication/json HTTPValidationError

GET /v1/lint/workspace/views​

List Workspace Saved Views

List the caller's saved workspace views (pinned first, then newest).

Operation id: list_workspace_saved_views_v1_lint_workspace_views_get

Parameters

NameInTypeRequiredDescription
tenant_slugquerystringyesURL-safe tenant slug that scopes the request.
authorizationheaderstring or nullnoJWT bearer token for authenticated access (Authorization: Bearer <token>).
X-API-Keyheaderstring or nullnoTenant-scoped API key used as an alternative to JWT bearer authentication.

Responses

StatusDescriptionBody
200Successful response for list workspace saved views.application/json LintWorkspaceSavedViewListResponse
422Validation Errorapplication/json HTTPValidationError

POST /v1/lint/workspace/views​

Create Workspace Saved View

Save the current workspace filter bundle under a name.

Operation id: create_workspace_saved_view_v1_lint_workspace_views_post

Parameters

NameInTypeRequiredDescription
tenant_slugquerystringyesURL-safe tenant slug that scopes the request.
authorizationheaderstring or nullnoJWT bearer token for authenticated access (Authorization: Bearer <token>).
X-API-Keyheaderstring or nullnoTenant-scoped API key used as an alternative to JWT bearer authentication.

Request body (required)

Request body for create workspace saved view.

Responses

StatusDescriptionBody
201Successful response for create workspace saved view.application/json LintWorkspaceSavedViewOut
422Validation Errorapplication/json HTTPValidationError

PATCH /v1/lint/workspace/views/{view_id}​

Update Workspace Saved View

Update a saved workspace view owned by the caller.

Operation id: update_workspace_saved_view_v1_lint_workspace_views__view_id__patch

Parameters

NameInTypeRequiredDescription
view_idpathstring (uuid)yesPath parameter identifying the view id segment.
tenant_slugquerystringyesURL-safe tenant slug that scopes the request.
authorizationheaderstring or nullnoJWT bearer token for authenticated access (Authorization: Bearer <token>).
X-API-Keyheaderstring or nullnoTenant-scoped API key used as an alternative to JWT bearer authentication.

Request body (required)

Request body for update workspace saved view.

Responses

StatusDescriptionBody
200Successful response for update workspace saved view.application/json LintWorkspaceSavedViewOut
422Validation Errorapplication/json HTTPValidationError

DELETE /v1/lint/workspace/views/{view_id}​

Delete Workspace Saved View

Delete a saved workspace view owned by the caller.

Operation id: delete_workspace_saved_view_v1_lint_workspace_views__view_id__delete

Parameters

NameInTypeRequiredDescription
view_idpathstring (uuid)yesPath parameter identifying the view id segment.
tenant_slugquerystringyesURL-safe tenant slug that scopes the request.
authorizationheaderstring or nullnoJWT bearer token for authenticated access (Authorization: Bearer <token>).
X-API-Keyheaderstring or nullnoTenant-scoped API key used as an alternative to JWT bearer authentication.

Responses

StatusDescriptionBody
200Successful response for delete workspace saved view.application/json map of boolean
422Validation Errorapplication/json HTTPValidationError

Schemas used​

HTTPValidationError​

Validation error response emitted when request data fails schema checks.

PropertyTypeRequiredDescription
detailarray of ValidationErrornoDetail.

LintWorkspaceBulkDecisionRequest​

Bulk assign / state-change request over workspace findings (CLX-4.1, #4859).

PropertyTypeRequiredDescription
itemsarray of LintWorkspaceBulkItemyesItems.
setLintWorkspaceBulkSetyesSet.

LintWorkspaceBulkDecisionResponse​

Bulk decision outcome: per-item results plus applied/failed tallies (CLX-4.1).

PropertyTypeRequiredDescription
resultsarray of LintWorkspaceBulkItemResultOutnoResults.
appliedCountintegernoNumber of applied.
failedCountintegernoNumber of failed.

LintWorkspaceFindingsResponse​

Paged workspace findings queue with pre-pagination facet counts (CLX-4.1).

PropertyTypeRequiredDescription
findingsarray of LintWorkspaceFindingOutnoFindings.
countintegernoNumber of count.
totalintegernoTotal.
limitintegernoLimit.
offsetintegernoOffset.
facetsmap of map of integernoFacets.

LintWorkspaceSavedViewCreate​

Request body for creating a saved workspace view (CLX-4.1, #4859).

PropertyTypeRequiredDescription
namestringyesHuman-readable name.
filtersobjectnoFilters.
querystringnoQuery.
sortstringnoSort.
isPinnedbooleannoIs Pinned.

LintWorkspaceSavedViewListResponse​

Envelope for listing saved workspace views (CLX-4.1, #4859).

PropertyTypeRequiredDescription
viewsarray of LintWorkspaceSavedViewOutnoViews.
countintegernoNumber of count.

LintWorkspaceSavedViewOut​

One saved workspace view owned by the caller (CLX-4.1, #4859).

PropertyTypeRequiredDescription
idstringyesStable resource identifier.
namestringyesHuman-readable name.
filtersobjectnoFilters.
querystringnoQuery.
sortstringnoSort.
isPinnedbooleannoIs Pinned.
createdAtstring or nullnoCreated At.
updatedAtstring or nullnoUpdated At.

LintWorkspaceSavedViewUpdate​

Request body for patching a saved workspace view (all fields optional).

PropertyTypeRequiredDescription
namestring or nullnoHuman-readable name.
filtersobject or nullnoFilters.
querystring or nullnoQuery.
sortstring or nullnoSort.
isPinnedboolean or nullnoIs Pinned.

LintWorkspaceSummaryResponse​

Tenant-wide lint posture rollup for the workspace header (CLX-4.1, #4859).

PropertyTypeRequiredDescription
subjectsmap of integernoSubjects.
gradeDistributionmap of integernoGrade Distribution.
axesarray of LintWorkspaceAxisSummaryOutnoAxes.
coverageobjectnoCoverage.
findingsmap of integernoFindings.
waiversmap of integernoWaivers.

LintWorkspaceTrendsResponse​

Daily trend series separating genuine remediation from policy change (CLX-4.1).

PropertyTypeRequiredDescription
daysintegeryesDays.
seriesarray of LintWorkspaceTrendPointOutnoSeries.

QualityRankSeriesResponse​

Per-format quality-grade distribution and drift over a window (IXH-2.7, #5102).

PropertyTypeRequiredDescription
daysintegeryesWindow size actually aggregated, in days.
windowStartstringyesWindow Start.
windowEndstringyesWindow End.
observationCountintegernoObservations folded into this response.
truncatedbooleannoTrue when more formats were observed than the response describes.
formatLimitintegernoMost format groups this response will describe.
stagesmap of integernoObservation tally by stage: preflight / committed.
outcomesmap of integernoObservation tally by gate outcome: pass / warn / block / error.
formatsarray of QualityRankFormatOutnoFormat groups, busiest first.