Lint Book
POST /api/creative/bookmaker/books/{book_id}/lint
POST
/api/creative/bookmaker/books/{book_id}/lint
Run a standalone ProseGuard lint check on all chapters of a book.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” book_id
required
Book Id
string
Query Parameters
Section titled “Query Parameters ” project_id
required
Project Id
string
Responses
Section titled “ Responses ”Successful Response
BookLintResponse
Result of a standalone ProseGuard lint pass on a book.
object
bookId
required
Bookid
string
errorCount
required
Errorcount
integer
warningCount
required
Warningcount
integer
infoCount
required
Infocount
integer
violations
Violations
Array<object>
BookLintViolationA single ProseGuard violation found during lint.
object
ruleId
required
Ruleid
string
message
required
Message
string
severity
required
Severity
string
paragraph
required
Paragraph
integer
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context