api-management-developer-portal icon indicating copy to clipboard operation
api-management-developer-portal copied to clipboard

The API version being used by the developer portal is being retired in September 2023

Open alexwiese opened this issue 10 months ago • 3 comments

Bug description

The version of the Azure API Management API being used by the developer portal is being retired next month.

On 30 September 2023, all API versions for the Azure API Management service prior to 2021-08-01 will be retired and API calls using those API versions will fail.

Microsoft recommend limiting control plane API calls to API Management to '2021-08-01' or newer:

Limit control plane API calls to API Management with version '2021-08-01' or newer.

The portal currently uses a preview version that will be retired next month:

export const managementApiVersion = "2021-04-01-preview";

When the minApiVersion configuration option is set to '2021-08-01' as recommended by Microsoft the portal fails to load products and APIs with the following error:

{
    "error": {
        "code": "MissingOrIncorrectVersionParameter",
        "message": "API version query parameter is not specified or was specified incorrectly.  Supported versions: 2021-08-01,2021-12-01-preview,2022-04-01-preview,2022-08-01,2022-09-01-preview,2023-03-01-preview,2023-05-01-preview  Example query param format: api-version=SupportedVersion",
        "details": null
    }
}

Reproduction steps

  1. Set the minApiVersion to '2021-08-01' as recommended by Microsoft
  2. Open the developer portal
  3. Navigate to the Products or APIs page
  4. Open browser dev tools to see the failed API requests from the portal

Expected behavior

The APIs and Products are loaded and displayed in the portal.

Is your portal managed or self-hosted?

Managed

API Management service name

N/A

Environment

  • Operating system: Windows 11
  • Browser: Edge
  • Version: 115.0.1901.203

alexwiese avatar Aug 15 '23 03:08 alexwiese