registry-git

Propose an edit to a git-sourced document as a pull request on the linked repo

post/registry-git/{asset}/{namespace}/{slug}/propose

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/registry-git/{asset}/{namespace}/{slug}/propose
  • Auth
    HTTP bearer

Path parameters

asset'apis' | 'schemas' required
namespacestring required
slugstring required

Request body

versionstring required
documentstring required
messagestring
baseShastring
baseBranchstring

Example request

{
  "version": "1.2.0"
}

Response

Default Response

prNumbernumber required
prUrlstring required
branchstring required

Changes