DevenConnect — v1.2.0 Migration Guide

Change 1 — Property Naming: PascalCase → camelCase

What's changing

Starting in v1.2.0, all JSON property names in API responses use camelCase (dealName, targetId) instead of PascalCase (DealName, TargetId).

Why this benefits you

camelCase is the standard convention for JSON APIs and the native expectation of virtually every modern HTTP client, SDK generator, and serializer across JavaScript/TypeScript, Python, Java, and beyond. This eliminates the need for custom naming policies or property-mapping shims just to consume our data — your deserialized objects will align naturally with your language and framework conventions.

What you need to do

Update property name references in your integration code. This is typically a find-and-replace operation within your API client models or deserialization mappings. If you generate a client from our OpenAPI spec, regenerating against the v1.2.0 spec is sufficient.

Example: response.DealName → response.dealName

This affects response payloads only — request bodies are not impacted.

Refer to the interactive API reference for updated response schemas: https://{tenant}.devensoft.com/api/core/swagger/

---

Change 2 — Default JSON Response Shape

What's changing

In v1.2.0, the default JSON response structure begins a versioned transition. The current response shape remains the default for now, but the new structure — based on a Collection+JSON pragmatic profile — will become the default in a future release. This gives you time to migrate on your schedule.

Why this benefits you

The updated format is cleaner, more consistent across all endpoints, and follows an established hypermedia standard. It reduces the need for custom parsing logic and makes it easier to build generic, reusable API client code as your integration with Devensoft grows.

How versioning works

You control which response shape you receive via the Accept request header:

Header value	Response shape
Accept: application/json (or omitted)	Current shape — default today, will switch to new shape in a future release
Accept: application/json;version=1	Legacy shape — explicitly pins to the current structure; supported for 6 months after the default switches
Accept: application/json;version=latest	New shape — opts into the future default now
Accept: application/vnd.collection+json;profile=pragmatic	New shape preview — available today via Swagger for early evaluation

What you need to do — before the default switches

Nothing is required immediately. The current response shape remains the default in v1.2.0.To prepare ahead of the switch, we recommend:

1. Preview the new shape now — use the Swagger UI at https://{tenant}.devensoft.com/api/core/swagger/ to send requests with Accept: application/vnd.collection+json;profile=pragmatic and inspect the new structure.
2. Plan your migration — the header is typically set in one centralized place (a base HTTP client class, request interceptor, or default headers config). Pinning to application/json;version=1 when you are ready to begin migration lets you control the cutover independently of our release schedule.
3. Complete migration within 3 months of the default switch — after that window, version=1 support will be retired.

We will communicate the default-switch date with advance notice ahead of that release.

---