From c448ea5df3e06b58f254b6df5cf347874fa8cf17 Mon Sep 17 00:00:00 2001 From: Jianye Xi <59603451+jianyexi@users.noreply.github.com> Date: Tue, 31 Jan 2023 11:30:02 +0800 Subject: [PATCH] Update ci-fix.md --- documentation/ci-fix.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index f8e92c819574..34f20eb5d2e1 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -138,7 +138,7 @@ This validator is to ensure the cadl & swagger files in PR are consistent and th | Error Code |Severity |Solution | |---|---|---| |MissingCadlFile| Error |Adding the related cadl project into {RP-Name} folder, like [Qumulo.Manaement](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/liftrqumulo/Qumulo.Management)| -|MissingExamplesDirectory| Error |The example files should be kept in the 'examples' folder under the cadl project,the cadl-autorest emitter will copy them into the output folder and create corresponding 'x-ms-examples' in the swagger automatically when geneates the swagger, you should also check in it in PR. See [cadl-autorest(https://github.com/Azure/cadl-azure/blob/main/packages/cadl-autorest/README.md#examples-directory)| +|MissingExamplesDirectory| Error |The example files should be kept in the 'examples' folder under the cadl project,the cadl-autorest emitter will copy them into the output folder and create corresponding 'x-ms-examples' in the swagger automatically when geneates the swagger, you should also check in it in PR. See [cadl-autorest](https://github.com/Azure/cadl-azure/blob/main/packages/cadl-autorest/README.md#examples-directory)| |InConsistentSwagger| Error |The generated swagger is inconsistent with the swagger in PR, so you need to re-generate swagger from cadl project and check in it. For how to generate swagger from cadl project, you can refer to [Complete Example and Generate OpenApi 2.0 spec](https://azure.github.io/cadl-azure/docs/getstarted/azure-resource-manager/step05) | |SwaggerNotExistInPR| Error |It occurs when there is a cadl file in the PR but the generated swagger is not present in the PR, so you need to add the swagger to the PR. For how to generate swagger from cadl project, you can refer to [Complete Example and Generate OpenApi 2.0 spec](https://azure.github.io/cadl-azure/docs/getstarted/azure-resource-manager/step05) | |GeneratedSwaggerNotFound| Error | It occurs when there is a cadl file in the PR but there is no swagger produced by the cadl-autorest emitter, so you need to check the cadl-project.yaml to see if it has the wrong configuration,like 'output-dir' or 'azure-resource-provider-folder'. |