docs: Update documentation for validate_only

PiperOrigin-RevId: 964167093
This commit is contained in:
Google APIs 2026-08-13 10:35:45 -07:00 committed by Copybara-Service
parent 29a82c8620
commit fa780596fb

View file

@ -367,8 +367,19 @@ message GenerateAuditReportRequest {
// `NIST_800_53`.
string compliance_framework = 5 [(google.api.field_behavior) = REQUIRED];
// Optional. If `true`, only validate the request and don't generate the audit
// report.
// Optional. If `true`, only validates the request and does not generate the
// audit report. This executes standard request validation (such as schema,
// framework existence, scope, and IAM checks) and skips the apply phase.
//
// Use this field for the following purposes:
// * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run
// dry-run mutations (e.g., `terraform plan`) without creating real
// resources or incurring costs.
// * **User Interface Validation**: Enable real-time form and permission
// validation in custom UIs before submitting requests.
// * **CI/CD & Automation**: Test your scripts, permissions, and parameters
// safely without triggering expensive Long-Running Operations (LROs) or
// consuming resource quotas.
bool validate_only = 8 [(google.api.field_behavior) = OPTIONAL];
}