api-docs-icon

A simple check to see if the requesting user has access to the preview doc project

GET
/ doc_project/ {doc_name}/ preview

x-doc-preview-org-id
string

Organization id of the doc preview environment associated with the password in x-doc-preview-password

x-doc-preview-password
string

A docgen preview environment password used to share preview docs with users outside of Sideko

pathname
string

relative path within docgen site requesting view permissions

Example:
%2Freferences%my-api%2Fmy-get-documentation

Responses

User can preview the doc project

application/json
boolean

Code Examples

Response