Back to GitHub API
GitHub API

description no longer required in code security config requests

BreakingBreaking change

This is a breaking change — integrations that rely on the affected behaviour will need updates before the change rolls out.

What changed

Two changes affect code security configuration endpoints: description is removed from the required array in request bodies (in two places), making it optional — this is additive/relaxing for clients. Additionally, the description response field now has "nullable": true, meaning clients must handle null values where they previously could assume a string. The nullable change could break clients that don't guard against null for description.

Open the source documentation