Skip to main content
PATCH
/
v1
/
reviewConfigs
/
{reviewConfig}
cURL
curl --request PATCH \
  --url https://api.example.com/v1/reviewConfigs/{reviewConfig} \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "enabled": true,
  "rules": [
    {
      "type": "TYPE_UNSPECIFIED",
      "level": "LEVEL_UNSPECIFIED",
      "namingPayload": {
        "maxLength": 123,
        "format": "<string>"
      },
      "numberPayload": {
        "number": 123
      },
      "stringArrayPayload": {
        "list": [
          "<string>"
        ]
      },
      "commentConventionPayload": {
        "required": true,
        "maxLength": 123
      },
      "stringPayload": {
        "value": "<string>"
      },
      "namingCasePayload": {
        "upper": true
      },
      "engine": "ENGINE_UNSPECIFIED"
    }
  ],
  "resources": [
    "<string>"
  ]
}
'
{
  "name": "<string>",
  "title": "<string>",
  "enabled": true,
  "rules": [
    {
      "type": "TYPE_UNSPECIFIED",
      "level": "LEVEL_UNSPECIFIED",
      "namingPayload": {
        "maxLength": 123,
        "format": "<string>"
      },
      "numberPayload": {
        "number": 123
      },
      "stringArrayPayload": {
        "list": [
          "<string>"
        ]
      },
      "commentConventionPayload": {
        "required": true,
        "maxLength": 123
      },
      "stringPayload": {
        "value": "<string>"
      },
      "namingCasePayload": {
        "upper": true
      },
      "engine": "ENGINE_UNSPECIFIED"
    }
  ],
  "resources": [
    "<string>"
  ]
}

Path Parameters

​
reviewConfig
string
required

The reviewConfig id.

Query Parameters

​
updateMask
string<field-mask>

The list of fields to update.

​
allowMissing
boolean

If set to true, and the config is not found, a new config will be created. In this situation, update_mask is ignored.

Body

application/json
​
title
string

The title of the review configuration.

​
enabled
boolean

Whether the review configuration is enabled.

​
rules
object[]

The SQL review rules to enforce.

​
resources
string[]

Resources using the config. Format: {resource}/{resource id}, e.g., environments/test.

Response

OK

​
name
string

The name of the SQL review config. Format: reviewConfigs/{reviewConfig}

​
title
string

The title of the review configuration.

​
enabled
boolean

Whether the review configuration is enabled.

​
rules
object[]

The SQL review rules to enforce.

​
resources
string[]

Resources using the config. Format: {resource}/{resource id}, e.g., environments/test.