API Version 2025-04-01
4 months ago by Kyle Welsby
🚨 Breaking Change: Metadata Values as Strings
As of version 2025-04-01, all metadata values will be returned as strings. This is a breaking change that affects how metadata is parsed in API responses.
What’s Changing?
- All metadata values are now strings – previous JSON nested objects will no longer be parsed.
- Numbers within strings will not return as integer types – all values, including numeric ones, will be represented as strings.
- Metadata remains flat – it continues to be a simple key-value store.
- Support for nested objects in metadata is not available and will not be supported in the future.
Action Required
- Update any integrations relying on JSON parsing for nested metadata values.
- Ensure numeric values within metadata are correctly handled as strings.
- Do not expect metadata values to be anything other than strings.
✨ New Features
API Users Tenant Endpoints
New endpoints are now available to view the tenant information for an API user. These endpoints provide details about the tenant associated with the API key making requests.
Configuration & Debt Handling Overrides (Upcoming)
We are laying the groundwork for upcoming features that will allow configuration management and overrides for how debts are handled within Ophelos. More details will be shared as these features become available.