Learn about recent and upcoming breaking or dangerous changes to the EAC GraphQL API.

Breaking changes are any changes that might require action from market participants using the EAC API. We divide these changes into two categories:

• Breaking: Changes that will break existing queries to the GraphQL API. For example, removing a field would be a breaking change.
• Dangerous: Changes that won't break existing queries but could affect the runtime behavior of clients. Adding an enum value is an example of a dangerous change.

We strive to provide stable APIs for market participants. Breaking and dangerous changes will be avoided as much as possible. When this can not be avoided due to evolution of the market, we will ensure to communicate in advance.

As part of the transition from NGESO to NESO, several breaking changes will be introduced that require action from market participants to update their integrations. All NGESO domain names used in the EAC GraphQL API and related services will be replaced with NESO domain names. This change affects API endpoints, authentication URLs, web application URLs, and documentation links. A redirection from the old NGESO domain to the new NESO domain has been implemented, but only for the web application URLs.

The new NESO URLs and addresses are detailed in the Environments and Authentication sections of our documentation. Please refer to these sections for the exact URLs to use in your integrations.

Aside from the domain updates, the functionality and structure of the API remain unchanged. Existing queries and mutations will continue to operate as before, provided they are directed to the new NESO endpoints.

Thoroughly test your applications and scripts to ensure they function correctly with the updated URLs. Confirm that authentication, data retrieval, and other API interactions are working as expected.

Effective Dates

• Mock Auction Environment: Changes have been applied.
• Production Environment: Changes are scheduled for 2024-10-01.
• Sandbox Environment: Changes will be applied on 2024-10-03.

To improve the user experience of your API, we introduced a couple of breaking changes. We are sorry for the inconvenient this will cause. We hope those changes will help you build your integration and get ready for the EAC go-live.

• The removeAllBaskets query has been removed and replaced by the removeBaskets query. Aside from a more standard naming, the new query has more parameters allowing you to filter the baskets you want to delete. See removeBaskets for the specifications and the delete all baskets section for an example.
• The field unit of the Basket type now hold a Unit instead of a ForeignObjectIdentifier allowing you to retrieve more information on the unit. See Basket for the exact specification and impacted queries and mutations.

In this release, a new validation rule has been added on the basket family IDs. When submitting baskets to an auction, the same family ID cannot be used across multiple units in a single auction submission. This validation ensures that family constraints are correctly applied on a per-unit basis in the auction algorithm. This validation rule, aligned with the intended market design, enforces a constraint that was always present in the algorithm but not previously checked in the input. It is important to note that this change does not affect auction outcomes, as the algorithm has always applied family constraints on a per-unit basis. Market participants that are using the family IDs for their baskets are invited to check that the IDs forwarded to EAC do not have the same value for different units in a given auction.

---