Changelog conventions
Conventions, versioning, and breaking change policy for the Conta Simples API
About the changelog
The changelog records significant changes to the Conta Simples API, including new features, changes, and fixes. We follow the Keep a Changelog style.
Conventions
Each release uses these change types:
| Type | Description |
|---|---|
| Added | New features |
| Changed | Changes to existing behavior |
| Deprecated | Features to be removed in a future version |
| Removed | Removed features |
| Fixed | Bug fixes |
| Security | Security-related fixes |
Versioning
The API follows Semantic Versioning:
- MAJOR: incompatible (breaking) changes
- MINOR: backward-compatible new features
- PATCH: backward-compatible fixes
Breaking changes are announced with at least 90 days notice and documented in the changelog.
Change notifications
How to get notified
Registered partners receive change notifications by email.
Breaking changes
For incompatible changes, we follow this process:
Announcement (D-90)
Email communication and a changelog entry with a Deprecated label.
Documentation (D-60)
Migration guide published with code examples.
Reminder (D-30)
Additional communication about the change.
Implementation (D-0)
The change is live. The old endpoint or behavior is no longer available.
Feedback
Suggestions for the API or documentation?
Support & contact
Send feedback through our support channels.
Last updated today
Built with Documentation.AI