seminaraHelp

seminara.online API Versioning & Deprecation Policy

Stability commitments, versioning lifecycle, and deprecation timeline for seminara.online developer APIs.

Seminara (https://seminara.online) provides clear, predictable stability guarantees for automated systems, server-to-server microservices, and autonomous AI agents.


1. URL Path Versioning

All Seminara REST APIs are explicitly versioned in the URI path:

https://seminara.online/api/v1/...
  • Current Stable Version: v1 (Active & Supported)
  • Breaking schema changes, removed fields, or altered authentication flows will always be released under a new major version path (e.g. /api/v2/).
  • Non-breaking changes (such as adding optional request parameters, new response fields, or new MCP tool definitions) are introduced backwards-compatibly into the current version without incrementing the major version.

2. Deprecation Policy & Lifecycle

When an API endpoint or version is marked for deprecation:

  1. Advance Notice: Seminara maintains a minimum 12-month support window from the formal announcement of deprecation before an endpoint is retired.
  2. Standard HTTP Headers (RFC 8594):
    • Deprecation: @<timestamp>: Indicates that the endpoint is deprecated.
    • Sunset: <HTTP-date>: Specifies the exact date when the endpoint will cease operation and return 410 Gone.
    • Link: <url>; rel="successor-version": Directs agents to the successor documentation and migration guide.

Example Deprecation Header Response

http
HTTP/1.1 200 OK
Deprecation: @1771718400
Sunset: Wed, 23 Feb 2028 00:00:00 GMT
Link: <https://seminara.online/docs/api-v2-migration>; rel="successor-version"

3. Machine-Readable Version Metadata

You can always check the current API version, supported endpoints, and deprecation statuses programmatically via the OpenAPI 3.1 specification at:

bash
curl -s https://seminara.online/openapi.json