# OpenAPI Quality Auditor API (`merlin-hermes/openapi-quality-auditor-api`) Actor

Deterministically audits supplied OpenAPI or Swagger text for endpoint inventory, documentation gaps, security-declaration coverage, and mutating-operation flags without calling any described API operation.

- **URL**: https://apify.com/merlin-hermes/openapi-quality-auditor-api.md
- **Developed by:** [Sean Burke](https://apify.com/merlin-hermes) (community)
- **Categories:** Developer tools
- **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.01 / actor start

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Merlin OpenAPI Quality Auditor — RapidAPI adapter

A narrow, deterministic HTTP API that statically inventories OpenAPI/Swagger operations and reports documentation/security-declaration gaps. It never calls operations in the submitted specification and does not fetch URLs.

### Routes

- `GET /health`
- `GET /openapi.json`
- `POST /v1/audit` with JSON `{ "openapi_document": "...", "source_label": "..." }`

Set `RAPIDAPI_PROXY_SECRET` in production and configure RapidAPI to send the same value in `X-RapidAPI-Proxy-Secret`. Input is capped at 1 MB. Do not log request bodies at the hosting layer because specifications can contain non-public metadata.

### Verify

```bash
npm ci
npm run verify
npm audit --audit-level=moderate
```

### Deployment status

The container is live as a public, monetized Apify Standby API at [OpenAPI Quality Auditor API](https://apify.com/merlin-hermes/openapi-quality-auditor-api). Its canonical Standby runtime, readiness route, OpenAPI contract, representative audit request, fixed 256 MB memory, 30-second idle timeout, limited permissions, and `$0.01` isolated-session start price have been verified.

RapidAPI publication remains separate and requires Sean's provider login, current-terms acceptance, PayPal/tax onboarding, and a least-privilege authentication bridge. Do not describe the API as listed on RapidAPI until the exact Hub listing, paid plan, and proxy-secret behavior are verified end to end. The Apify account retains a zero-paid-spend hard limit.

## Actor input object example

```json
{}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("merlin-hermes/openapi-quality-auditor-api").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("merlin-hermes/openapi-quality-auditor-api").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call merlin-hermes/openapi-quality-auditor-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=merlin-hermes/openapi-quality-auditor-api",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/acts/cMMVOIhDdqfrZyJ95/builds/ybJKuuTe4ewEnH3Be/openapi.json
