Create a docs project

Create a docs project. Omit provider to have Scalar host the repository.

Body

required

application/json

name
Type: string
required
provider
Type: "forgejo" or "github" or "bitbucket"enum
required
bitbucketRepository
Type: object
Properties: 2
blank
Type: boolean
githubRepository
Type: object
Properties: 2
isPrivate
Type: boolean
slug
Type:
min length:
1
max length:
60

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json

post/v1/docs

import Scalar from '@scalar/sdk';

const client = new Scalar({
  bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var
});

const docsProject = await client.scalarDocs.createProject({
  name: 'Acme Documentation',
  provider: 'forgejo',
});

console.log(docsProject);

Show Schema

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL",
  "name": "Acme Documentation",
  "slug": "acme-api",
  "isPrivate": false,
  "accessGroups": [
    "UakgbKJ5m9gl0JDMbcJqL"
  ],
  "loginPortalUid": "LakgbKJ5m9gl0JDMbcJqL",
  "activeThemeId": "TakgbKJ5m9gl0JDMbcJqL",
  "agentEnabled": true,
  "analyticsEnabled": true,
  "lastPublished": null,
  "publishStatus": "published"
}

Default Response

List all docs projects

Get a docs project