Skip to content
Ishvana Ishvana Docs

Batch Lint

POST
/api/writing/proseguard/batch-lint

Lint all documents in the project and return aggregated results.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
project_id
Project Id
string
""

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

BatchLintResponse

Response from batch-linting all project documents.

object
documents
Documents
Array<object>
BatchLintDocResult

Lint result for a single document in a batch run.

object
documentId
required
Documentid
string
documentTitle
required
Documenttitle
string
violationCount
required
Violationcount
integer
errorCount
required
Errorcount
integer
warningCount
required
Warningcount
integer
totalViolations
Totalviolations
integer
0
totalDocuments
Totaldocuments
integer
0

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object