# Documentation Deprecation Monitor (`flintglade/documentation-deprecation-monitor`) Actor Monitor explicit HTML, Markdown, and OpenAPI documentation for evidence-backed deprecations, removals, authentication changes, migrations, and endpoint revisions. - **URL**: https://apify.com/flintglade/documentation-deprecation-monitor.md - **Developed by:** [Flintglade](https://apify.com/flintglade) (community) - **Categories:** Developer tools, Automation, Other - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $50.00 / 1,000 documentation checks 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 a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use 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 ## Documentation Deprecation Monitor Monitor explicit documentation URLs and report evidence-backed endpoint, authentication, migration, deprecation, sunset, removal, version, and policy changes. ### What this does not do - No generic site crawl or universal breaking-change detection. - No promise that all breaking changes are documented. - No code migration, patch generation, or LLM summary. - No login bypass or private-doc monitoring without user-authorized credentials. ### Sources and authorization Every HTML, Markdown, or OpenAPI document is an explicit user URL passing the SSRF gate. Version 1 uses bounded HTTP only, follows at most five revalidated redirects, accepts only optional Authorization/Accept headers, and performs no recursive discovery. ### Input Submit 1-100 documents with `url`, `type`, and optional `priorUrl`, HTML selectors, or secret headers. A `baselineStoreId` enables scheduled monitoring. ```json {"documents":[{"url":"https://flintglade-tools.github.io/apify-fixtures/docs/current.html","type":"html","priorUrl":"https://flintglade-tools.github.io/apify-fixtures/docs/prior.html"}],"taxonomy":["endpoint","auth","migration","deprecation","sunset","removal"],"concurrency":1} ```` ### Output Each row contains baseline state, canonical hashes, category deltas, exact before/after excerpts and locators, OpenAPI operation changes, severity, source metadata, and diff artifacts. The final run summary is uncharged. ### Pricing `documentation-check` costs **$0.05 per terminal document check**. Baseline creation, unchanged/changed reports, and definitive 404/410 results are charged. Blocked/auth/rate/transient/parse failures and missing requested priors are uncharged. Maximum event cost is admitted checks multiplied by $0.05, plus platform usage. ### State and partial failures Explicit `priorUrl` comparisons are stateless. Persistent baselines are journaled in the selected KVS and committed only after Apify confirms the paid event. A 304 with a valid baseline is a successful unchanged check; uncharged failures never advance state. Duplicate inputs receive explicit uncharged rows. ### Resources and data handling Limits are 256 MB minimum, 1024 MB default, 2048 MB maximum, 600 seconds, 2 MB per response, eight concurrent requests, and 100 documents. Secret header values are never echoed. Delete the run storages and chosen baseline KVS records to remove data. ### Rights, attribution, and limitations Users must be authorized to fetch submitted documentation. The controlled fixture is Flintglade-authored. Historical changelog text is labeled and cannot create a high-severity alert by itself. Provider documentation can be incomplete, and unchanged text cannot prove an API is unchanged. Support: support@flintglade.com # Actor input Schema ## `inputSchemaVersion` (type: `integer`): Versioned runtime input contract. ## `documents` (type: `array`): Explicit HTML, Markdown, or OpenAPI documents; each URL is fetched without recursive discovery. ## `baselineStoreId` (type: `string`): Optional KVS ID for scheduled monitoring state. ## `taxonomy` (type: `array`): Change categories to report. ## `renderMode` (type: `string`): Version 1 uses bounded HTTP only. ## `concurrency` (type: `integer`): Maximum concurrently active document requests. ## Actor input object example ```json { "inputSchemaVersion": 1, "documents": [ { "url": "https://flintglade-tools.github.io/apify-fixtures/docs/current.html", "type": "html", "priorUrl": "https://flintglade-tools.github.io/apify-fixtures/docs/prior.html" } ], "taxonomy": [ "endpoint", "auth", "migration", "deprecation", "sunset", "removal" ], "renderMode": "http", "concurrency": 4 } ``` # Actor output Schema ## `defaultDataset` (type: `string`): No description ## `artifactManifest` (type: `string`): No description # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "documents": [ { "url": "https://flintglade-tools.github.io/apify-fixtures/docs/current.html", "type": "html", "priorUrl": "https://flintglade-tools.github.io/apify-fixtures/docs/prior.html" } ] }; // Run the Actor and wait for it to finish const run = await client.actor("flintglade/documentation-deprecation-monitor").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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "documents": [{ "url": "https://flintglade-tools.github.io/apify-fixtures/docs/current.html", "type": "html", "priorUrl": "https://flintglade-tools.github.io/apify-fixtures/docs/prior.html", }] } # Run the Actor and wait for it to finish run = client.actor("flintglade/documentation-deprecation-monitor").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 '{ "documents": [ { "url": "https://flintglade-tools.github.io/apify-fixtures/docs/current.html", "type": "html", "priorUrl": "https://flintglade-tools.github.io/apify-fixtures/docs/prior.html" } ] }' | apify call flintglade/documentation-deprecation-monitor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=flintglade/documentation-deprecation-monitor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Documentation Deprecation Monitor", "description": "Monitor explicit HTML, Markdown, and OpenAPI documentation for evidence-backed deprecations, removals, authentication changes, migrations, and endpoint revisions.", "version": "0.1", "x-build-id": "WHfpkVWabLVTQ5LD0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/flintglade~documentation-deprecation-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-flintglade-documentation-deprecation-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/flintglade~documentation-deprecation-monitor/runs": { "post": { "operationId": "runs-sync-flintglade-documentation-deprecation-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/flintglade~documentation-deprecation-monitor/run-sync": { "post": { "operationId": "run-sync-flintglade-documentation-deprecation-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "documents" ], "properties": { "inputSchemaVersion": { "title": "Input schema version", "minimum": 1, "maximum": 1, "type": "integer", "description": "Versioned runtime input contract.", "default": 1 }, "documents": { "title": "Documents", "minItems": 1, "maxItems": 100, "type": "array", "description": "Explicit HTML, Markdown, or OpenAPI documents; each URL is fetched without recursive discovery.", "items": { "type": "object", "additionalProperties": false, "properties": { "url": { "title": "Current URL", "description": "Public HTTPS documentation URL.", "type": "string", "maxLength": 2048 }, "type": { "title": "Document type", "description": "Parser contract for this document.", "type": "string", "enum": [ "html", "markdown", "openapi" ] }, "priorUrl": { "title": "Prior URL", "description": "Optional explicit prior revision for a stateless comparison.", "type": "string", "maxLength": 2048 }, "includeSelectors": { "title": "Include selectors", "description": "Optional CSS selectors defining retained HTML regions.", "type": "array", "maxItems": 20, "items": { "type": "string", "maxLength": 500 } }, "excludeSelectors": { "title": "Exclude selectors", "description": "Optional CSS selectors removed before canonicalization.", "type": "array", "maxItems": 20, "items": { "type": "string", "maxLength": 500 } }, "headers": { "title": "Authorized request headers", "description": "Optional Authorization or Accept values. Secret values are never echoed; runtime validation accepts only those two names.", "type": "object", "editor": "json", "maxProperties": 2, "additionalProperties": true } }, "required": [ "url", "type" ] } }, "baselineStoreId": { "title": "Baseline key-value store", "maxLength": 100, "type": "string", "description": "Optional KVS ID for scheduled monitoring state." }, "taxonomy": { "title": "Evidence taxonomy", "minItems": 1, "maxItems": 8, "uniqueItems": true, "type": "array", "description": "Change categories to report.", "items": { "type": "string", "enum": [ "endpoint", "auth", "migration", "deprecation", "sunset", "removal", "version", "policy" ], "enumTitles": [ "Endpoint", "Authentication", "Migration", "Deprecation", "Sunset", "Removal", "Version", "Policy" ] }, "default": [ "endpoint", "auth", "migration", "deprecation", "sunset", "removal" ] }, "renderMode": { "title": "Render mode", "enum": [ "http" ], "type": "string", "description": "Version 1 uses bounded HTTP only.", "default": "http" }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Maximum concurrently active document requests.", "default": 4 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```