Changed on

Convert a Forgejo-backed DocsProject into a GitHub-backed one. Reads every file from the Forgejo repo and opens a single PR on the chosen GitHub repo putting the content under scalar-docs/. A repo with no commits has nothing to collide with and nothing to review against, so it is initialised with the docs at its root on the default branch, and no pull request is returned.

post/docs-projects/{projectUid}/link-github

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/docs-projects/{projectUid}/link-github
  • Auth
    HTTP bearer

Path parameters

projectUidstring required
Example:UakgbKJ5m9gl0JDMbcJqL

Request body

installationIdinteger required
repoIdinteger required

Response

Default Response

Example response

{
  "project": {
    "uid": "UakgbKJ5m9gl0JDMbcJqL",
    "createdAt": 1735689600,
    "updatedAt": 1735689600,
    "name": "Acme Documentation",
    "activeDeployment": {
      "uid": "UakgbKJ5m9gl0JDMbcJqL",
      "domain": "docs.example.com",
      "publishedAt": 1735689600
    },
    "lastPublished": 1735689600,
    "lastPublishedUid": "PakgbKJ5m9gl0JDMbcJqL",
    "loginPortalUid": "LakgbKJ5m9gl0JDMbcJqL",
    "userInfoHookUrl": "https://example.com/hooks/user-info",
    "userInfoHookSecretUid": "UakgbKJ5m9gl0JDMbcJqL",
    "activeThemeId": "TakgbKJ5m9gl0JDMbcJqL",
    "typesenseId": 42,
    "agentEnabled": true,
    "analyticsEnabled": true,
    "chatInsightsEnabled": true,
    "accessGroups": [
      "UakgbKJ5m9gl0JDMbcJqL"
    ],
    "slug": "acme-api",
    "publishStatus": "published",
    "publishMessage": "Documentation published successfully.",
    "repository": {
      "repositoryUid": "UakgbKJ5m9gl0JDMbcJqL"
    },
    "remoteActivity": {
      "at": 1735689600
    }
  }
}

Changes