Skip to content

Changelog

The version history of API-dex itself, release by release. Entries are grouped by minor version and combine changes from the portal and the platform API. Only user-facing changes are listed. The announcements an organisation publishes to its own portal users live in the portal under Documentation, see Portal layout.

Unreleased

Translated specifications

  • Producers publish a translation of a specification's titles, summaries and descriptions per portal language as an OpenAPI Overlay, from the browser or the CLI manifest. The stored specification stays canonical; API-dex merges the overlay in when a consumer opens it, and downloads follow the language on screen. Supported: en-GB, nl-NL, de-DE, fr-FR, es-ES, se-SE, ar-SA. See Translating a specification.
  • New four-step Upload spec page (Destination, Specification, Overlays, Review) replaces the drag-and-drop area, with category specifications shared by several products and version override.
  • The API-dex CLI gains validate, which checks overlay files and, with --require-locales, that every specification declares the required languages.

3.1.0

Accessibility

  • Reworked core UI components (buttons, form fields, checkboxes, radios, selects, dialogs, tabs, tables) to meet WCAG 2.2 Level A — full keyboard operability, screen-reader labelling, and visible focus states across the portal.

Environments & access

  • Admins can now restrict which roles may access a given environment, independent of team or application permissions.
  • Sharing an application is now restricted to application owners and portal admins; the share dialog explains this instead of showing a "consumed" column.
  • Fixed a flicker/flash of "no environment access" that could briefly appear on login or page refresh before access finished loading.

Applications & credentials

  • Application credential cards show a hint tooltip explaining credential checks, and support one-click copy to clipboard.
  • Apigee environments: improved the authentication-method picker and added a Workload Identity Federation (WIF) toggle with a confirmation step (you're warned before WIF removes existing credentials).

API specs

  • Uploading an unsupported or invalid OpenAPI spec now returns a clear, readable error message instead of a raw technical one.

External developer portal

  • Public page search now works for anonymous (logged-out) visitors.

3.0.x (3.0.0 – 3.0.2)

This was a major visual and structural redesign of the portal.

Design refresh

  • Replaced the underlying UI framework (Vuetify) with a new in-house component library — buttons, cards, data tables, dialogs, forms, and navigation all redesigned for a more consistent look and better performance.
  • New customisable theming: colour presets, and code-editor (Monaco) theme customisation for organisations that want to match their own branding.
  • Multi-client visual identities, so the same portal can present differently per organisation.

Onboarding

  • New guided walkthrough/tour that helps first-time users create their first application, including an inline example request.

Analytics

  • Redesigned analytics dashboard: time-range selection, trend indicators on KPI cards, and the ability to reset filters. Selected filters are now reflected in the page URL so they survive a refresh or can be shared.

API version comparison

  • Replaced the old "changelog" feature on API specs with a clearer Compare versions view: pick two spec versions and see a structured, side-by-side diff of what changed between them.

Subscription/company management

  • New module for managing companies and their subscriptions (where enabled for your organisation).

Email

  • Notification emails now use branded HTML templates.

Platform changes

  • API catalog no longer supports the SAP gateway platform.
  • The backend now starts up gracefully if its database isn't reachable yet, instead of crashing — improving reliability during deploys.
  • Sensitive values are now redacted from application logs.
  • Fixed (3.0.1): a bug where a disabled module could still appear as a clickable link in the sidebar.

Earlier versions

This changelog starts at 3.0.0, the most recent major redesign. History before that is available from AppyThings on request.