Release Notes¶

v0.11.1¶

Date: 2025-06-23

Overview (v0.11.1)¶

This release focuses on the documentation.

Other Changes (v0.11.1)¶

Documentation update:
- Overview renamed to Discover
- Get started moved to Discover
- New menu item Resources with Operations, Release notes
- Job V2 reference as sub navigation of Reference

v0.11.0¶

Date: 2025-06-20

Overview (v0.11.0)¶

Internal maintenance release that improves the management of Modigie Pub/Sub repositories and their job orchestration pipelines.

Improvements (v0.11.0)¶

Tenant infrastructure A Modigie Pub/Sub repository is automatically updated when its job orchestration pipeline is updated.

v0.10.1¶

Date: 2025-06-19

Overview (v0.10.1)¶

Internal maintenance release for the migration of the Modigie Identity API.

Improvements (v0.10.1)¶

Tenant infrastructure This release allows the Modigie Pub/Sub API to manage tenant-specific infrastructure through the new Modigie Identity API which replaces the previous Modigie Customer API.

v0.10.0¶

Date: 2025-06-12

Overview (v0.10.0)¶

This release focuses on the migration of the API specification from Swagger 2.0 to Open API 3.0.

What's New (v0.10.0)¶

API specification in Open API 3.0 format Our Swagger 2.0-based specification has been replaced with an Open API 3.0-based specification.
- Impact: Developers can now use more powerful tools to explore the REST resource schemas used by our API.
- Affected Components: Documentation.

Bug Fixes (v0.10.0)¶

Duplicate job ID in preview: Resolved an issue where duplicate job IDs were not being handled correctly in the preview environment.
- Resolution: The preview environment now correctly discards duplicate job requests with identical payloads.

Other Changes (v0.10.0)¶

Documentation clarification: Clarified idempotency behavior in the documentation.
- Details: Provided more examples and explanations on how the system handles duplicate requests.
Documentation of schema:
- Details: Job V2 reference generated from Open API 3.0 specification.

v0.9.5¶

Date: 2025-06-16

Overview (v0.9.5)¶

This release introduces a few schema changes that we have applied based on further exploration and feedback from beta users.

Breaking Changes (v0.9.5)¶

Breaking Change: Schema changes

We introduced changes that requires action on your part to ensure your prototype continues to work as expected.

Reason for the change:

In order to simplify the API surface and make it more future-proof we have decided to make a few changes to the schema.

Impact:

One property names has changed and your application needs to adjust the code that produces job request messages or consumes job response messages to use the new name. For a list of changed definition names that should not make code changes necessary, see below.

Migration guide:

To adapt to this change, you need to update your code as follows.

Where you publish requests and consume responses, rename the property employment.jobTitle → employment.position

Before:

Example with the old name employment.jobTitle:

body.json

{
  "payload": {
    "employment": {
      "company": {
        "title": "Acme Inc.",
        ...
      },
      "jobTitle": {
        "title": "Head of Engineering",
        ...
      }
    },
    ...
  },
  ...
}

After:

Example with the new name employment.position:

body.json

{
  "payload": {
    "employment": {
      "company": {
        "title": "Acme Inc.",
        ...
      },
      "position": {
        "title": "Head of Engineering",
        ...
      }
    },
    ...
  },
  ...
}

Affected components:

Any client applications that publish job request messages.
Any client applications that consumes job response messages.

Improvements (v0.9.5)¶

Renamed definitions For improved client support and request validation, we are preparing to migrate our API specification from Swagger 2.0 to Open API 3.0. As part of these efforts, we have changed definition names that should not affect application code, but improve discovery and understanding.
- Us → DoNotCallOrTcpaUs
- RichSource → JobV2Source
- RichSourceObjectId → JobV2SourceObjectId
- RichSourceObjectType → JobV2SourceObjectType
- RichSourceObjectSystem → JobV2SourceObjectSystem
- RichSourcePropertyName → JobV2SourcePropertyName
- CompanyTitleNullable → JobV2CompanyTitleNullable
- CompanyTitle → JobV2CompanyTitle
- CompanyVerificationTitle → JobV2CompanyVerificationTitle
- CompanyVerification → JobV2CompanyVerification
- JobTitle → JobV2PositionTitle
- JobTitleNullable → JobV2PositionTitleNullable
- JobVerification → JobV2PositionVerification
- JobVerificationTitle → JobV2PositionVerificationTitle
- JobV2TitleRequest → JobV2PositionRequest
- JobV2Title → JobV2Position
- UrlOrNoneRequest → UrlRequestNullable
- UrlOrNone → UrlNullable
- EmailAddressV2Request → EmailAddressRequest
- EmailAddressV2 → EmailAddress
- PhoneNumberV2Request → ItuPhoneV2Request
- PhoneNumberV2 → ItuPhoneV2
- LocalityV2RequestNullable → LocalityRequestNullable
- LocalityV2Request → LocalityRequest

Bug Fixes (v0.9.5)¶

Architecture Diagram Typo: Corrected a minor typographical error in the architecture diagram within the documentation.
- Resolution: The diagram now accurately reflects the intended text.

Other Changes (v0.9.5)¶

Documentation Update: Updated the documentation regarding push vs. pull subscriptions.
- Details: Clarified best practices and considerations for choosing subscription types.