Skip to content
Last updated

Here are the steps to achieve the actions you’ve asked for using Redocly:

ActionSteps
1. Protect the debrief.md page for "pearl" role- In your Redocly project, navigate to the "Security" tab.
- Under "Role-based access control", click on "Add role".
- Name the role "pearl" and save.
- Go back to the "Security" tab and click on "Add rule".
- Set the rule to allow access to the "debrief.md" page only for users with the "pearl" role.
2. Create a code walkthrough- In your Redocly project, go to the "Content" tab.
- Click on "Add section" and select "Code walkthrough".
- Fill in the details like title, description, and add code snippets or images to explain each step.
- Click "Save" to create the walkthrough.
3. Show only the mock server in the try it console- In your Redocly project, go to the "APIs" tab.
- Click on the API you want to modify.
- Under "Servers", ensure only the mock server (e.g., "https://api.redoc.ly/") is listed.
- Click "Save" to apply the changes.
4. Run API monitoring on a regular schedule- In your Redocly project, go to the "Monitoring" tab.
- Click on "Create new monitor".
- Set up the monitor with the desired API, endpoints, and frequency (e.g., every hour).
- Click "Save" to schedule the monitor.
- To automate this process, you can use Redocly's API to create and manage monitors programmatically.
5. Make headings purple colored in Redocly- Redocly uses Markdown for formatting, and Markdown doesn't support colored headings natively.
- However, you can use CSS to style headings. Here's how:
- In your Redocly project, go to "Themes" tab.
- Click on "Customize".
- Add the following CSS to the "Custom CSS" section:
css\n.h1, .h2, .h3, .h4, .h5, .h6 {\n color: purple;\n}\n
- Click "Save" to apply the changes. This will make all heading levels (h1 to h6) purple.