Error when saving OpenAPI specification in Azure Api Management

Ashan Perera 21

I have an API in api management service with an openapi spec.127814-api.txt

I want to edit this file to add 1 more definition but I get this error when I click save. "The field serviceUrl is invalid."
Even if I don't change the document and just open it and click save, I still get the same error.

MayankBargali-MSFT 69,576 Reputation points

2021-09-01T03:24:08.033+00:00

@Ashan Perera I have created the API using your attached OpenAPI defination. When I tried to add Defination I don't see the same error as you have observed and the defination was created sucessfully. Can you share the screenshot and what defination you are trying to add?
Ashan Perera 21 Reputation points

2021-09-01T04:00:42.97+00:00

I'm clicking the drop down next to the pencil icon

Even if I don't edit it and click save, I still get this error.
Basankar, Rohan 1 Reputation point

2021-09-01T12:14:23.997+00:00

hii even i am facing the same exact issue
earlier it was working fine and now this issue is there in all resource group which are in different region
Dylan Smith 1 Reputation point

2021-09-02T12:27:21.83+00:00

Running into the same issue here. Have an old Swagger 2.0 spec. Even with no edits, I can't save it and I get that same error.

I tried the step below of copying the base url to webservice URL or serviceURL, but the openAPI schema error identifies that as an additional property that shouldn't be there.

UPDATE: I was trying to add those parameters to the OpenAPI spec. Turns out I needed to go to the API's Settings tab in APIM and copy the Base URL into the Web service URL there. It wasn't a swagger problem, it was an API problem that prevented me from saving the swagger.

Accepted answer

MayankBargali-MSFT 69,576 Reputation points

2021-09-03T10:49:29.637+00:00
@Ashan Perera I was able to reproduce the issue if in case I remove the backend HTTP url (i.e. Web service URL). The issue was not reproduce with the attached openapi spec as it already has the field servers. When I tried to edit the YAML the issue was not reproduced with your spec.

The issue should only observed in case if someone has already imported the API and removed the backend URL then you should oberve the error as "The field serviceUrl is invalid" when you edit it again and doesnot make any changes and tried to save it. As the spec was become invalid as the servers filed doesnot have any URL as you have already deleted them.
servers:

url: 'https://apim-blacksmith-dev.azure-api.net/authapi'
Please sign in to rate this answer.

0 comments No comments
Sign in to comment

1 additional answer

Mönig Markus - Munich-MR 1 Reputation point

2021-09-01T12:26:44.29+00:00

we have exactly the same problem...
Please sign in to rate this answer.
Mönig Markus - Munich-MR 1 Reputation point

2021-09-01T12:29:42.517+00:00

seems that webservice url is now a mandantory field. copied the base url to webservice url... that worked for us.

Basankar, Rohan 1 Reputation point

2021-09-01T13:16:30.55+00:00

Thanks this worked for us .
but what does webservice url mean , its not there in microsoft documentation mentioned below

https://learn.microsoft.com/en-us/azure/api-management/import-app-service-as-api

and can this be done from arm template because we have many api to be updated
Sign in to comment

Share via

Error when saving OpenAPI specification in Azure Api Management

1 additional answer