Skip to content

GitHub: Interactions schemas

3 GitHub schemas with complete fields and constraints.

← Interactions operations · All schemas

Add users to the pull request creation cap bypass list for a repository — request body — body

FieldTypePresenceDescription and constraints
$objectRootA list of user logins to add or remove from the pull request creation cap bypass list.
usersarrayRequired within parentA list of user logins to add or remove from the bypass list.
users[]stringEach item

Set interaction restrictions for a repository — request body — body

FieldTypePresenceDescription and constraints
$objectRootLimit interactions to a specific type of user for a specified duration
expirystringOptionalThe duration of the interaction restriction. Default: `one_day`.
One of: one_day, three_days, one_week, one_month, six_months
limitstringRequired within parentThe type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.
One of: existing_users, contributors_only, collaborators_only

Set interaction restrictions for a repository — response body

FieldTypePresenceDescription and constraints
$objectRootInteraction limit settings.
expires_atstringRequired within parentFormat: date-time
limitstringRequired within parentThe type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.
Known values: existing_users, contributors_only, collaborators_only
originstringRequired within parent

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.