Change Requests
A change request in GitBook is the entity of a revision to a space in progress.
List change requests for a space.
/spaces/{spaceId}/change-requests
The unique id of the space
Identifier of the page results to fetch.
The number of results per page
If defined, only change requests matching this status will be returned.
draft
, open
, archived
, merged
If defined, only change requests with contributions from this user will be returned.
Create a new change request for a space.
/spaces/{spaceId}/change-requests
The unique id of the space
Subject of the change-request
Merge a change request in the primary content of a space.
/spaces/{spaceId}/change-requests/{changeRequestId}/merge
The unique id of the space
The unique ID of the change request or its number identifier in the space
Update a change-request with changes from primary content.
/spaces/{spaceId}/change-requests/{changeRequestId}/update
The unique id of the space
The unique ID of the change request or its number identifier in the space
Get the latest content revision for a change request.
/spaces/{spaceId}/change-requests/{changeRequestId}/content
The unique id of the space
The unique ID of the change request or its number identifier in the space
If false
is passed, "git" mutable metadata will not returned. Passing false
can optimize performances of the lookup.
If false
is passed, content will not be computed
List all files in a change request content
/spaces/{spaceId}/change-requests/{changeRequestId}/content/files
The unique id of the space
The unique ID of the change request or its number identifier in the space
Identifier of the page results to fetch.
The number of results per page
If false
is passed, "git" mutable metadata will not returned. Passing false
can optimize performances of the lookup.
If false
is passed, content will not be computed
Import content in a change request.
/spaces/{spaceId}/change-requests/{changeRequestId}/content/import
The unique id of the space
The unique ID of the change request or its number identifier in the space
website
, docx
, markdown
, html
, zip
, confluence
, github-wiki
, dropbox-paper
, notion
, quip
, google-docs
, open-api
URL of the content to import.
Get a page by its path in a change request.
/spaces/{spaceId}/change-requests/{changeRequestId}/content/path/{pagePath}
The unique id of the space
The unique ID of the change request or its number identifier in the space
The path of the page in the revision.
Output format for the content.
document
, markdown
If false
is passed, "git" mutable metadata will not returned. Passing false
can optimize performances of the lookup.
If false
is passed, content will not be computed
Get a page by its ID in a change request.
/spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}
The unique id of the space
The unique ID of the change request or its number identifier in the space
The unique id of the page
Output format for the content.
document
, markdown
If false
is passed, "git" mutable metadata will not returned. Passing false
can optimize performances of the lookup.
If false
is passed, content will not be computed
Import external content into a page of a change-request by its ID.
/spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/import
The unique id of the space
The unique ID of the change request or its number identifier in the space
The unique id of the page
website
, docx
, markdown
, html
, zip
, confluence
, github-wiki
, dropbox-paper
, notion
, quip
, google-docs
, open-api
URL of the content to import.
Last updated
Was this helpful?