registry-git

Changed on

Link a GitHub repo as the source of truth for a registry resource: opens a PR adding the canonical file, then pushes and merges on the tracked branch drive publishes

post/registry-git/{asset}/{namespace}/{slug}/link-external

Request

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

Path parameters

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

Request body

provider'github' | 'bitbucket' required
installationIdinteger
repoIdinteger
branchstring
publishOnPushboolean
publishOnMergeboolean

Response

Default Response

Example response

{
  "repository": {
    "uid": "UakgbKJ5m9gl0JDMbcJqL",
    "createdAt": 1735689600,
    "updatedAt": 1735689600
  },
  "source": {
    "repositoryUid": "UakgbKJ5m9gl0JDMbcJqL",
    "lastPublishedAt": 1735689600
  }
}

Changes

  • 5e4c47d6805bRevision changes
    • breaking

      added subschema #2 subschema #3 to the response property oneOf list for the response status

    • info

      the response's property default value unixTimestamp() was removed for the status

    • info

      the response's property default value unixTimestamp() was removed for the status

    • info

      removed subschema #2 subschema #3 from the response property oneOf list for the response status

  • ab42e041dc0aRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property