Cannot update API description for an API revision

Question

I'm having trouble deploying an API revision to APIM if the new revision has an updated description. I'm using ARM template deployment, and using OpenAPI to import APIs. But when I deploy, I get the error below:

##[error]ValidationError: Can't change property Description for non-current revision.

And even when I go to the portal, I see the description field is grayed out for the new revision (see screenshot below).
API description is something I should be able to update in a revision.
Any help is appreciated.

Answer 1

Hi @Muriuki, Levi M Thanks for reaching out. This is by design. There are several fields in the OpenAPI specification that cannot be updated unless you are changing to current API revision. For details, please see https://learn.microsoft.com/en-us/azure/api-management/edit-api#update-the-swagger

https://learn.microsoft.com/en-us/azure/api-management/api-management-revisions#revision-descriptions

let me know incase of further queries, I would be happy to assist you.

Please 'Accept as answer' and ‘Upvote’ if it helped so that it can help others in the community looking for help on similar topics.