# Direct Docs Queries

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

1. Protecting debrief.md so only users with the "pearl" role can access it

Redocly’s documentation does not provide a built-in mechanism for role-based access control (RBAC) at the markdown or page level directly within the static documentation or OpenAPI reference output. Typically, access control for documentation pages is managed at the web server, CDN, or authentication layer outside of Redocly itself. If you are using Redocly’s Developer Portal, you can implement authentication and authorization using external solutions (like OAuth, SSO, or custom middleware), but there is no direct way in markdown or config to require a "pearl" role for a single page ^1 ^2 ^3.

Recommended approach:

• Use your hosting platform’s authentication features to protect the debrief.md page and restrict it to users with the "pearl" role.
• If using a custom portal, implement role-checking logic in your authentication middleware or web server configuration.

2. Creating a Code Walkthrough

Redocly’s Developer Portal supports interactive, step-by-step guides using MDX files and built-in UI components. To create a code walkthrough:

• Create an MDX file in your portal project.
• Import components such as OpenApiTryIt, Alert, and ExplainStep from @redocly/developer-portal/ui.
• Structure your walkthrough as a sequence of steps, each possibly including explanations, code blocks, and live API calls via the OpenApiTryIt component ^3.

Example:

import { OpenApiTryIt, ExplainStep } from '@redocly/developer-portal/ui';

# API Code Walkthrough

<ExplainStep>
  Step 1: Authenticate to the API.
</ExplainStep>

<OpenApiTryIt operationId="login" />

<ExplainStep>
  Step 2: Fetch user data.
</ExplainStep>

<OpenApiTryIt operationId="getUser" />

This approach guides users through code and API interactions interactively ^3.

3. Showing Only the Mock Server in the Try It Console

Redocly allows you to configure which servers are shown in the "Try It" console. To show only the mock server:

• In your OpenAPI definition, under the servers array, include only the mock server URL for the relevant environment or reference.
• Alternatively, configure the Developer Portal or Reference settings to display just the mock server in the "Try It" panel.

This ensures users can only make requests to the mock server, not to real environments ^3.

4. Running API Monitoring on a Regular Schedule

Redocly itself does not offer built-in scheduled API monitoring (like uptime checks or synthetic monitoring). API monitoring typically requires external tools (e.g., Postman Monitors, Pingdom, or custom scripts with CI/CD schedulers). Redocly focuses on documentation, linting, and previewing APIs, not on executing or scheduling API calls for monitoring purposes ^1 ^2 ^3 ^4.

Recommended approach:

• Use an external monitoring tool to run scheduled API checks.
• Optionally, integrate such monitoring results into your Redocly portal via custom components or status pages.

5. Making Headings Purple in Redocly

To change the color of headings in Redocly documentation:

• Use custom CSS in your Developer Portal or Reference theme configuration.
• For example, add the following CSS to your project’s custom stylesheet:

h1, h2, h3, h4, h5, h6 {
  color: #800080; /* Purple */
}

Integrate this CSS via your portal’s theme configuration or by including it in your build process. This will turn all headings purple as desired.

Summary Table