Version Guide

API Version Format

The AXSMarine OpenAPI Specification uses a three-part version number:

1 . X . Y
│   │   └── Specification structure revision
│   └──── API content revision
└──────── Major version 1 . X . Y
│   │   └── Specification structure revision
│   └──── API content revision
└──────── Major version

What Each Number Means

1 — Major Version

Only changes in the event of a fundamental architectural overhaul. Would be communicated in advance as a breaking change.

X — API Content Revision

Increments every time the API content changes:

• ➕ An endpoint was added or removed
• ➕ An HTTP method was added or removed from a path
• 🔄 A request parameter was added, removed, or modified
• 🔄 A request or response body schema was updated
• 🔄 A response status code was added or removed

Y — Specification Structure Revision

Increments when the structure or format of the spec changes, but API behaviour is identical:

• New top-level sections added (e.g. servers, security, tags)
• New metadata or extension fields introduced (e.g. x- extensions)
• Formatting or organisation of the file updated

Do I Need to Update My Integration?

X changed — ✅ Review the Release Notes — API behaviour changed

Only Y changed — ⚡ Re-import the spec file — no logic changes needed

Neither changed — ✅ No action needed

Reading the Version at a Glance

1.0.0 — Initial release

1.1.0 — API content updated (X bumped)

1.1.1 — Spec structure improved, API content unchanged (Y bumped)

1.2.1 — API content updated again, structure unchanged (X bumped)