api-docs

Creates a new api document for the namespace

post/managed-doc/{namespace}

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/managed-doc/{namespace}
  • Auth
    HTTP bearer

Path parameters

namespacestring required

Request body

titlestring required
descriptionstring
versionstring required
documentstring required
slugstring required
rulesetstring
isPrivateboolean
docsProjectUidstring

Example request

{
  "version": "1.2.0",
  "slug": "acme-api",
  "docsProjectUid": "UakgbKJ5m9gl0JDMbcJqL"
}

Response

Default Response

uidstring required
versionUidstring required
titlestring required
jsonShastring required
yamlShastring required
versionShastring required

Changes