# OpenAPI Contract Monitor - Operation & Schema Changes Monitor public OpenAPI JSON operation definitions, deprecation flags and schema fingerprints. Export saved comparisons for agent and API integration review. Canonical product page: https://mayd-it.com/data-tools/actors/openapi-operation-change-monitor/ ## Example input ```json { "urls": [ "https://petstore3.swagger.io/api/v3/openapi.json" ], "maxResults": 5, "itemsPerQuery": 3 } ``` ## Choose this tool Agent builders and integration teams tracking public API contracts they depend on. Stable method/path records expose contract drift before integration review. Useful output columns: `method`, `path`, `operationId`, `deprecated`, `contractHash`, `schemaCatalogHash`. ## Practical workflow Start with a public JSON OpenAPI specification. Petstore demonstrates the format; replace it with your dependency. Establish a baseline, then review changed operation and schema fingerprints before running your own compatibility tests. No API operation is called. ## Check the fit Public OpenAPI 3.x JSON documents only. External references are not fetched. Schema catalog hashes detect changes but do not establish which operations break. Missing operations in a bounded window never prove removal. Petstore is an explicitly labeled demonstration API; APIs.guru examples are mirrored specifications. No API operations are executed. ## Real output sample One selected row from a 2026-10-18 run. One saved row with selected scalar fields. Nested structures remain available in full Actor output. Run: FjDbuTH5XD5LBa3NI. Summary status: ok. Incomplete: false. Historical bounded output from the recorded run. Current source values may differ. ```json { "recordId": "04cd0d3bba0635560dedbeb3373dfc2595c836f2b28a0652dbd38f86881b2fb7", "title": "POST /pet", "method": "POST", "path": "/pet", "operationId": "addPet", "deprecated": false, "contractHash": "a361a32a1b0809d080cee8211a7dd804146dadfb54f52808245f9b332767c437", "schemaCatalogHash": "5631c6f791509e938d8d360fc2c0d0d886134daac0fc9b308792fd045d6e6f26", "url": "https://petstore3.swagger.io/api/v3/openapi.json", "observedAt": "2026-10-18T15:34:14.071Z" } ``` ## Full guide # OpenAPI Contract Monitor - Operation & Schema Changes OpenAPI Contract Monitor - Operation & Schema Changes icon **Stable method/path records expose contract drift before integration review.** Monitor public OpenAPI JSON operation definitions, deprecation flags and schema fingerprints. Export saved comparisons for agent and API integration review. ## Start in under a minute 1. Paste public openapi json urls into the first input field, or use the included sample. 2. Keep the five-result limit for your first run and choose **Start**. 3. Open **Observations**, **Scope and diagnostics**, or the **Readable run report** in Output. Export CSV or JSON from the dataset. ```json { "urls": [ "https://petstore3.swagger.io/api/v3/openapi.json" ], "maxResults": 5, "itemsPerQuery": 3 } ``` No source account, API key, paid proxy or extra subscription is required for these public endpoints. Source availability and rate limits still apply. ## Who this helps Agent builders and integration teams tracking public API contracts they depend on. ## A real output sample Captured in a successful bounded Apify run; arrays and long text are shortened for readability. Values are snapshots, not live guarantees. ```json { "recordId": "04cd0d3bba0635560dedbeb3373dfc2595c836f2b28a0652dbd38f86881b2fb7", "title": "POST /pet", "method": "POST", "path": "/pet", "operationId": "addPet", "deprecated": false, "contractHash": "a361a32a1b0809d080cee8211a7dd804146dadfb54f52808245f9b332767c437", "schemaCatalogHash": "5631c6f791509e938d8d360fc2c0d0d886134daac0fc9b308792fd045d6e6f26", "url": "https://petstore3.swagger.io/api/v3/openapi.json", "observedAt": "2026-10-18T15:25:47.753Z", "comparisonStatus": "not_requested" } ``` ## What you receive One row per unique confirmed observation. Every row includes a stable `recordId`, title, source URL and observation time. | Field | Meaning | |---|---| | `method` | Source-reported method; missing optional values remain null. | | `path` | Source-reported path; missing optional values remain null. | | `operationId` | Source-reported operation id; missing optional values remain null. | | `deprecated` | Source-reported deprecated; missing optional values remain null. | | `contractHash` | Source-reported contract hash; missing optional values remain null. | | `schemaCatalogHash` | Source-reported schema catalog hash; missing optional values remain null. | | `comparisonStatus` | not_requested, new, changed or unchanged | | `changedFields` | Fields different from your last saved observation | | `previous` | Previous saved source values when comparison is enabled | ## Saved comparisons Enable **Compare with saved observations**, choose a snapshot name, and reuse the same input scope. The first run establishes history; it cannot report changes before that point. Enable **Save only new or changed observations** for later runs if you want a change-only export. An unchanged run can correctly save zero rows. Only confirmed saved rows advance history. A bounded or failed run never establishes that a missing record was deleted. History is stored in a named key-value store in the running user's account. Use one writer per snapshot: do not overlap runs against the same snapshot. Change the snapshot name when starting a new independent workflow. ## Scope and limitations Public OpenAPI 3.x JSON documents only. External references are not fetched. Schema catalog hashes detect changes but do not establish which operations break. Missing operations in a bounded window never prove removal. Petstore is an explicitly labeled demonstration API; APIs.guru examples are mirrored specifications. No API operations are executed. At most ten input values and five hundred saved rows per run. Each input uses a bounded source response. Shared feeds are cached within the run; public documents may require a robots.txt request. Requests are paced. Responses are capped at 8 MiB and share the run deadline. No authentication bypass or code execution is performed. HTTP 429 stops further requests. Source failures appear in SUMMARY and the HTML report, never as paid data rows. ## Pricing The configured base price is **$0.001 per saved observation**, plus **$0.00005 per start** at the default memory. Five observations cost $0.00505 at that base rate. Applicable plan discounts and the Store pricing panel govern actual charges. Set a maximum charge in Run options. Diagnostics, reports and unchanged skipped rows are not dataset result events. ## A practical workflow Agent builders and integration teams tracking public API contracts they depend on. Stable method/path records expose contract drift before integration review. Start with the included five-result sample, review source links, then save your own scope as an Actor task. Use a named snapshot for repeat runs and keep source metadata with downstream exports. ## Make it recurring Save an Actor task with your inputs, then attach an Apify Schedule. For change detection, keep the same snapshot and avoid overlapping runs. Add an integration to deliver results to your own spreadsheet or workflow. No external delivery is enabled automatically. ## Frequently asked questions **Why did a repeat run return zero rows?** With change-only mode enabled, unchanged records are skipped. Check SUMMARY to distinguish this from empty matches, limits, or an upstream error. **Does a missing record mean it was deleted?** No. Searches cover a bounded source window; a record can move outside it. Missing records never become deletion claims. **Can I export or integrate the data?** Yes. Use Apify dataset exports for CSV/JSON, or the Actor API and your own integrations. No external message or delivery is enabled by default. ## Examples 1. **Public OpenAPI JSON URLs: https://petstore3.swagger.io/api/v3/o** — A bounded https://petstore3.swagger.io/api/v3/openapi.json observation sample. Review source evidence and export rows or compare them in a later run. 2. **Public OpenAPI JSON URLs: https://api.apis.guru/v2/specs/github** — A bounded https://api.apis.guru/v2/specs/nytimes.com/top_stories/2.0.0/openapi.json observation sample. Review source evidence and export rows or compare them in a later run. 3. **Public OpenAPI JSON URLs: https://api.apis.guru/v2/specs/nytime** — A bounded https://api.apis.guru/v2/specs/nytimes.com/books_api/3.0.0/openapi.json observation sample. Review source evidence and export rows or compare them in a later run. ## Source and support [Official source documentation](https://spec.openapis.org/oas/v3.1.1.html). This independent Mayd IT tool is not affiliated with the source platform. Open an Actor issue with the run ID and expected result, or contact bmay@mayd-it.com. Never include credentials. ## Workflow library and related tools [Product guide](https://mayd-it.com/data-tools/actors/openapi-operation-change-monitor/) · [Workflow and real output](https://mayd-it.com/data-tools/actors/openapi-operation-change-monitor/workflow.md) · [All data tools](https://mayd-it.com/data-tools/) · [Use with AI](https://mayd-it.com/data-tools/ai/)