Import rules from YAML
POST /api/writing/proseguard/import/{project_id}
POST
/api/writing/proseguard/import/{project_id}
Import ProseGuard rules from YAML. Use dry_run=true to validate without saving.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” project_id
required
Project Id
string
Query Parameters
Section titled “Query Parameters ” dry_run
Dry Run
If true, validate only without saving
boolean
If true, validate only without saving
Request Body required
Section titled “Request Body required ” YamlImportRequest
Request to import YAML rules.
object
yamlContent
required
Yamlcontent
YAML content to import
string
Responses
Section titled “ Responses ”Successful Response
ImportValidationResult
Result of YAML import validation (dry_run=true).
Attributes: valid: Whether the import would succeed errors: List of validation errors warnings: List of validation warnings rulesets_parsed: Number of rulesets successfully parsed
object
valid
required
Valid
Whether the import would succeed
boolean
errors
required
Errors
Validation errors
Array<string>
warnings
required
Warnings
Validation warnings
Array<string>
rulesetsParsed
required
Rulesetsparsed
Number of rulesets parsed
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