Octri

docs playground

Shows the request playground's settings: whether it's on, the base URL requests go to, the default authentication and the timeout. With no base URL of its own, it shows the one it inherits. There's no draft: a change is live on your docs site as soon as the command returns, the same as saving in API Studio. See the playground.

bash
octri docs playground [show | set key=value …]

octri docs playground set key=value …

Changes one or more settings. Values are text, except true and false, which turn something on or off. @ reads a value from a file, as in css=@docs.css. A dotted key sets one field inside another, as in defaultAuth.type=bearer. You can set one part of the default authentication on its own, and the other part keeps its value.

Arguments

key=valuestringrequired

The settings.

ValueMeaning
enabledtrue or false
baseUrlThe address requests are sent to
defaultAuth.typeThe authentication readers start with
defaultAuth.headerNameThe header an API key goes in
requestTimeoutMsHow long a request may take, in milliseconds

Examples

Show the playground

bash
octri docs playground
Output
✔ Loading playground

API playground off
  baseUrl                 inherits https://api.acme.com/v1
  defaultAuth.type        inherit
  defaultAuth.headerName  Authorization
  allowedOrigins          none
  requestTimeoutMs        10000
  octri docs playground set key=value …

Point it at a sandbox

bash
octri docs playground set enabled=true baseUrl=https://sandbox.acme.com