Versions and Contract Changes

REST, MCP, tool-registry, and documentation version compatibility.

Leenops has several independently versioned integration layers.

LayerCurrent contractHow to verify
REST APIURL version v1, activePath prefix and X-API-Version where emitted
OpenAPIPublication temporarily pausedOpenAPI status
Public MCP adapterleenops-mcp@2.0.4Pin the npm version in the client
Shared tool registryLive, permission-aware catalog/api/mcp/session and /api/mcp/tools/list
DocumentationDated per pagelast_updated and the machine bundle

REST versioning

REST uses URL-path versioning:

https://workspace.leenops.com/api/v1/...

v1 is the only active version in the application version schedule. Some v1 response helpers emit:

X-API-Version: v1
X-API-Latest-Version: v1

Header emission is not uniform across every handler, so the path remains the authoritative version identifier.

Contract maturity is separate from version

A route being under /api/v1 does not by itself make it a supported external contract.

  • Guide operations are listed in Public API Status and have dedicated documentation.
  • Unlisted operations are private or unsupported and must not be probed.
  • Deprecated operations should not be used for new integrations.

See Public API Status.

MCP compatibility

The local leenops-mcp package supplies the STDIO protocol adapter and tool registration. Leenops's hosted API performs authentication and execution.

For reproducible tests:

  1. Pin leenops-mcp@2.0.4.
  2. record /api/mcp/session capability counts.
  3. retrieve live schemas from /api/mcp/tools/list.
  4. do not assume a count or schema from an older client cache.

Hosted behavior can change without a client-package release when the existing tool name/schema remains compatible. New names or schema changes normally require an adapter release.

Breaking-change handling

Before changing an integration:

  • check the OpenAPI publication status and compare the current official download when available;
  • retrieve fresh MCP tool schemas;
  • read pages whose last_updated date changed;
  • exercise the read/write smoke tests;
  • verify deprecated routes and package versions.

Leenops does not currently publish a guaranteed minimum public deprecation window. Supported integrations should email support@leenops.com if they require a contractual migration window.

2026-07-29 integration documentation release

  • Canonical operational origin changed in examples to workspace.leenops.com.
  • Supported REST contract verified at 7 paths and 17 operations.
  • API-key catalog verified at 34 scopes.
  • MCP catalog guidance changed to require live discovery instead of a cached count.
  • Agent guide, recipes, troubleshooting, llms.txt, and full machine bundle added.
  • OpenAPI limited to the supported public contract and stripped of internal source and validator metadata.
  • Webhook daily-drain behavior and signature format corrected.
  • Zapier availability documented without exposing private route inventory.