Publish the draft of a GitHub bundle as a branch, a commit, and a pull request (REQ-123).
POST
/docs/{docId}/publish
const url = 'https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/publish';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"message":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/publish \ --header 'Content-Type: application/json' \ --data '{ "message": "example" }'Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”docId
required
string format: uuid
The ID of one spec doc.
Request Body
Section titled “Request Body”Media typeapplication/json
object
message
The commit message and pull request title.
string
Examplegenerated
{ "message": "example"}Responses
Section titled “ Responses ”The pull request.
Media typeapplication/json
object
pr_url
required
string
pr_number
required
integer
Examplegenerated
{ "pr_url": "example", "pr_number": 1}default
Section titled “default”An error.
Media typeapplication/problem+json
RFC 9457 problem details with a stable code.
object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required
A stable machine-readable error code.
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "code": "example"}