Pull Requests
On this page, we'll dive into the Pull Request model.
The Pull Request model
The Pull Request model contains the pull request metadata.
Required properties
- Name
id- Type
- integer
- Description
Unique identifier for the object.
- Name
url- Type
- string
- Description
- Name
repository_url- Type
- string
- Description
- Name
labels_url- Type
- string
- Description
- Name
comments_url- Type
- string
- Description
- Name
events_url- Type
- string
- Description
- Name
html_url- Type
- string
- Description
- Name
number- Type
- integer
- Description
- Name
state- Type
- string
- Description
One of
open,closed
- Name
title- Type
- string
- Description
- Name
locked- Type
- boolean
- Description
- Name
comments- Type
- integer
- Description
- Name
created_at- Type
- string
- Description
Timestamp in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSSZ.
- Name
updated_at- Type
- string
- Description
Timestamp in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSSZ.
- Name
author_association- Type
- string
- Description
One of
COLLABORATOR,CONTRIBUTOR,FIRST_TIMER,FIRST_TIME_CONTRIBUTOR,MANNEQUIN,MEMBER,NONE,OWNER
Optional properties
- Name
state_reason- Type
- string
- Description
One of
completed,reopened,not_planned
- Name
body- Type
- string
- Description
- Name
active_lock_reason- Type
- string
- Description
- Name
closed_at- Type
- string
- Description
Timestamp in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSSZ.
- Name
draft- Type
- boolean
- Description
- Name
body_html- Type
- string
- Description
- Name
body_text- Type
- string
- Description
- Name
timeline_url- Type
- string
- Description
- Name
merged_at- Type
- string
- Description
Timestamp in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSSZ.
- Name
diff_url- Type
- string
- Description
- Name
patch_url- Type
- string
- Description