[BUG] Could not read OpenAPI specification

[lrlemos]

Release version

v4.10.1

Describe the bug

This week, my apiops "publish" pipeline stopped working. I have an old process that uses Development Resource Kit, which also stopped working. I believe there was some update to the APIM platform that caused the problem

Expected behavior

Deploy with success

Actual behavior

Error using APIOPs

info: Publisher[0]
Beginning execution...
info: Publisher[0]
Commit ID was not specified, will put all artifact files...
info: Microsoft.Hosting.Lifetime[0]
Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
Hosting environment: Production
info: Microsoft.Hosting.Lifetime[0]
Content root path: /home/vsts/work/1/s
info: Publisher[0]
Putting API azure-ai-language...
crit: Publisher[0]
System.IO.IOException: Could not read OpenAPI specification file /home/vsts/work/1/s/artifacts/apis/azure-ai-language/specification.yaml.
at publisher.Api.GetOpenApiV3SpecificationText(OpenApi openApiSpecificationFile)
at publisher.Api.GetApiSpecificationJson(ApiSpecificationFile specificationFile, CancellationToken cancellationToken)
at publisher.Api.GetApiJson(ApiName apiName, ApiInformationFile apiInformationFile, ApiSpecificationFile specificationFile, JsonObject configurationApiJson, CancellationToken cancellationToken)
at publisher.Api.PutApi(ApiName apiName, ApiInformationFile apiInformationFile, ApiSpecificationFile specificationFile, JsonObject configurationApiJson, ServiceUri serviceUri, PutRestResource putRestResource, ILogger logger, CancellationToken cancellationToken)
at publisher.Api.<>c__DisplayClass23_0.<b__4>d.MoveNext()
--- End of stack trace from previous location ---

=================================================================
Error using Development Resource Kit

• az deployment group create --resource-group --parameters ../parameters/apim-parameters-tst.json --template-file apim-api.template.json --parameters PolicyXMLBaseUrl=/ PolicyXMLSasToken=<token

ERROR: {"status":"Failed","error":{"code":"DeploymentFailed","message":"At least one resource deployment operation failed. Please list deployment operations for details. Please see https://aka.ms/arm-deployment-operations for usage details.","details":[{"code":"BadRequest","message":"{\r\n "error": {\r\n "code": "ValidationError",\r\n "message": "One or more fields contain incorrect values:",\r\n "details": [\r\n {\r\n "code": "ValidationError",\r\n "target": "value",\r\n "message": "Error downloading document from the provided link."\r\n }\r\n ]\r\n }\r\n}"},{"code":"BadRequest","message":"{\r\n "error": {\r\n "code": "ValidationError",\r\n "message": "One or more fields contain incorrect values:",\r\n "details": [\r\n {\r\n "code": "ValidationError",\r\n "target": "value",\r\n "message": "Error downloading document from the provided link."\r\n }\r\n ]\r\n }\r\n}"}]}}

Reproduction Steps

1 - Execute Extrator from DEV environment
2 - Execute publisher to TST environment

[github-actions]

  Thank you for opening this issue! Please be patient while we will look into it and get back to you as this is an open source project. In the meantime make sure you take a look at the [closed issues](https://github.com/Azure/apiops/issues?q=is%3Aissue+is%3Aclosed) in case your question has already been answered. Don't forget to provide any additional information if needed (e.g. scrubbed logs, detailed feature requests,etc.).
  Whenever it's feasible, please don't hesitate to send a Pull Request (PR) our way. We'd greatly appreciate it, and we'll gladly assess and incorporate your changes.

[lrlemos]

We found local error here. Issue Cancelled

[leopardorossi]

Hi @lrlemos, I am experiencing the same issue. Can you please tell me what was your local problem? Maybe it is the same is blocking my pipeline. Thank you very much.

[lrlemos]

In my version of devops with Jenkins + DevOps Resource Kit, the problem was a powershell update, which changed the SaSToken format (the "?" disappeared at the beginning). The infrastructure team fixed it, but I don't know what the versions were. In my Azure Devops + apiops version I didn't find the history of what was the problem. Enviado do Outlook<http://aka.ms/weboutlook>

…

________________________________ De: leopardorossi ***@***.***> Enviado: sexta-feira, 9 de fevereiro de 2024 16:11 Para: Azure/apiops ***@***.***> Cc: lrlemos ***@***.***>; Mention ***@***.***> Assunto: Re: [Azure/apiops] [BUG] Could not read OpenAPI specification (Issue #423) Hi @lrlemos<https://github.com/lrlemos>, I am experiencing the same issue. Can you please told me what was your local problem? Maybe it is the same is blocking my pipeline. Thank you very much. — Reply to this email directly, view it on GitHub<#423 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ASHFQMSBZQQ32ZV476DRUQDYSZDBPAVCNFSM6AAAAAA7XYGBYSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMZWGIYDANJSGA>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[megamax34]

I had this issue as well but my problem was when I ran the extractor pipeline with API_SPECIFICATION_FORMAT = OpenAPIV2Yaml I got the error above when trying to publish. To fix the issue, I ran the pipeline again with API_SPECIFICATION_FORMAT = OpenAPIV3Yaml and the publisher pipeline worked fine after that.

Error line:
crit: Publisher[0]
System.IO.IOException: Could not read OpenAPI specification file /home/vsts/work/1/s/artifacts/apis/xxxxxxxxx-api/specification.yaml.
at publisher.Api.GetOpenApiV3SpecificationText(OpenApi openApiSpecificationFile)