Skip to main content
POST
Propose a change

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

A change to write against a repository, as a draft.

repo_id
string
required

The repository's registry id, or its name.

title
string
required

One line, used as the branch name.

Maximum string length: 200
summary
string
default:""

Why the change, for the reviewer.

Maximum string length: 8000
base_ref
string
default:""

Branch to start from; blank is default.

Maximum string length: 200
edits
CodeProposalEdit · object[]

The files it changes. At least one.

Response

Successful Response

A proposal as a page reads it.

id
string
required
repo_id
string
required
owner
string
required
title
string
required
status
string
required
created_at
string
required
repo_name
string
default:""
remote
string | null
provider
string | null
repo_version
string
default:""
summary
string
default:""
base_ref
string
default:""
branch_name
string
default:""
decided_by
string | null
decided_at
string | null
decided_reason
string | null
external_url
string | null
error
string | null
edits
CodeProposalEdit · object[]