Skip to content
Ishvana Ishvana Docs

Add a suppression for a document

POST
/api/writing/proseguard/suppressions/{project_id}/{document_id}

Persist a single suppression.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
project_id
required
Project Id
string
document_id
required
Document Id
string

Request Body required

Section titled “Request Body required ”
SuppressionRequest

Request to add a single suppression.

object
suppressionType
required
Suppressiontype

Type of suppression

string
Allowed values: rule instance
value
required
Value

Rule ID or violation signature

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

SaveResponse

Response for save operations.

object
success
required
Success
boolean
message
required
Message
string

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