Versioning

The major version is part of the path: /api/v1.

#What may change within v1 (without notice)

• new endpoints, events and optional request parameters;
• new fields in responses and event payloads;
• new values of enumerations (statuses, event types, error codes);
• clearer error messages (detail).

Your client must ignore unknown fields and tolerate unknown enum values. Don't validate responses against a closed schema.

#Breaking changes

Removing or renaming a field, changing its type or meaning, or making a parameter required ships as a new major version (/api/v2). After v2 is available, v1 keeps working for at least 12 months. During that time:

• responses of retired operations carry Deprecation (RFC 9745) and Sunset (RFC 8594) headers;
• IT administrators of organisations that still call them receive an e-mail;
• the changelog lists what changed and how to migrate.

The OpenAPI document (https://api.elearning.edu.pl/openapi.json) uses semantic versioning in info.version.