Skip to content
This repository was archived by the owner on Aug 26, 2025. It is now read-only.

Verify type spec api review gen#2921

Closed
praveenkuttappan wants to merge 7 commits into
mainfrom
Verify_typeSpec_Api_review_gen
Closed

Verify type spec api review gen#2921
praveenkuttappan wants to merge 7 commits into
mainfrom
Verify_typeSpec_Api_review_gen

Conversation

@praveenkuttappan
Copy link
Copy Markdown

@praveenkuttappan praveenkuttappan commented Mar 24, 2023

Test TypeSpec APi review gen

@workflow-bot-test
Copy link
Copy Markdown

workflow-bot-test Bot commented Mar 24, 2023

Hi, @praveenkuttappan Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app-test
    Copy link
    Copy Markdown

    openapi-pipeline-app-test Bot commented Mar 24, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    widgets.json 2022-11-01-preview(39e217b) 2022-11-01-preview(main)
    Rule Message
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'widgetName' renamed or removed?
    New: Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json#L296:15
    Old: Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json#L272:15
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.
    ️️✔️~[Staging] Lint(RPaaS) succeeded [Detail] [Expand] 
    Validation passes for Lint(RPaaS).
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️❌SwaggerAPIView: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ Failed to generate swagger APIView. The readme file format is invalid and the tag is not defined. Use the provided readme template for guidance readme template. For more details, please check the detail log. "How to fix":"Check the readme file and make sure the readme file format is valid and the tag is defined. Use the provided readme template"
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️️✔️PoliCheck succeeded [Detail] [Expand] 
    Validation passed for PoliCheck.
    ️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️❌~[Staging] PrettierCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ HowToFix Code style issues found
    path: Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json
    ️️✔️~[Staging] SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    ️️✔️CadlValidation succeeded [Detail] [Expand] 
    Validation passes for CadlValidation.
    ️❌TypeSpec Validation: 13 Errors, 28 Warnings failed [Detail]

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    ❌ unknown-identifier Unknown identifier Cadl
    Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L9
    ❌ unknown-identifier Unknown identifier Cadl
    Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L10
    ❌ unknown-identifier Unknown identifier Cadl
    Location: specification/cognitiveservices/OpenAI.Authoring/finetune.tsp#L93
    ❌ unknown-decorator Unknown decorator
    Location: specification/cognitiveservices/OpenAI.Authoring/finetune.tsp#L93
    ❌ unknown-identifier Unknown identifier route
    Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L27
    ❌ unknown-decorator Unknown decorator
    Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L27
    ❌ unknown-identifier Unknown identifier get
    Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L28
    ❌ unknown-decorator Unknown decorator
    Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L28
    ❌ GeneratedSwaggerNotFound "details":"The generated swagger file from typespec specification/contosowidgetmanager/Contoso.WidgetManager can not be found."
    ❌ InConsistentSwagger "details":"The generated swagger file v1.1/openapi.json from typespec specification/cognitiveservices/AnomalyDetector is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json' in PR,
    please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log."
    ❌ MissingExamplesDirectory "details":"The 'examples' directory is missing in the typespec folder specification/cognitiveservices/OpenAI.Authoring,
    please ensure the 'examples' is added in the PR."
    ❌ MissingExamplesDirectory "details":"The 'examples' directory is missing in the typespec folder specification/cognitiveservices/OpenAI.Inference,
    please ensure the 'examples' is added in the PR."
    ❌ InConsistentSwagger "details":"The generated swagger file v1.1/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json' in PR,
    please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log."
    ⚠️ @azure-tools/typespec-azure-core/use-extensible-enum Enums should be defined without the @fixed decorator.
    Location: cognitiveservices/AnomalyDetector/univariate/models.tsp#L34
    ⚠️ @azure-tools/typespec-azure-core/casing-style The names of Property types must use camelCase
    Location: cognitiveservices/AnomalyDetector/univariate/models.tsp#L176
    ⚠️ @azure-tools/typespec-azure-core/use-standard-operations Operation 'DetectUnivariateEntireSeries' should be defined using a signature from the Azure.Core namespace.
    Location: cognitiveservices/AnomalyDetector/univariate/routes.tsp#L11
    ⚠️ @azure-tools/typespec-azure-core/use-standard-operations Operation 'DetectUnivariateLastPoint' should be defined using a signature from the Azure.Core namespace.
    Location: cognitiveservices/AnomalyDetector/univariate/routes.tsp#L26
    ⚠️ @azure-tools/typespec-azure-core/use-standard-operations Operation 'DetectUnivariateChangePoint' should be defined using a signature from the Azure.Core namespace.
    Location: cognitiveservices/AnomalyDetector/univariate/routes.tsp#L39
    ⚠️ @azure-tools/typespec-azure-core/use-extensible-enum Enums should be defined without the @fixed decorator.
    Location: cognitiveservices/AnomalyDetector/multivariate/models.tsp#L21
    ⚠️ @azure-tools/typespec-azure-core/casing-style The names of Property types must use camelCase
    Location: cognitiveservices/AnomalyDetector/multivariate/models.tsp#L100
    ⚠️ @azure-tools/typespec-azure-core/casing-style The names of Property types must use camelCase
    Location: cognitiveservices/AnomalyDetector/multivariate/models.tsp#L390
    ⚠️ @azure-tools/typespec-azure-core/use-extensible-enum Enums should be defined without the @fixed decorator.
    Location: cognitiveservices/AnomalyDetector/multivariate/models.tsp#L37
    ⚠️ @azure-tools/typespec-azure-core/casing-style The names of Property types must use camelCase
    Location: cognitiveservices/AnomalyDetector/multivariate/models.tsp#L268
    ⚠️ @azure-tools/typespec-azure-core/use-extensible-enum Enums should be defined without the @fixed decorator.
    Location: cognitiveservices/AnomalyDetector/multivariate/models.tsp#L43
    ⚠️ @azure-tools/typespec-azure-core/use-standard-operations Operation 'GetMultivariateBatchDetectionResult' should be defined using a signature from the Azure.Core namespace.
    Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L11
    ⚠️ @azure-tools/typespec-azure-core/use-standard-operations Operation 'TrainMultivariateModel' should be defined using a signature from the Azure.Core namespace.
    Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L26
    ⚠️ @azure-tools/typespec-azure-core/casing-style The names of Property types must use camelCase
    Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L44
    ⚠️ @azure-tools/typespec-azure-core/use-standard-operations Operation 'ListMultivariateModels' should be defined using a signature from the Azure.Core namespace.
    Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L49
    ⚠️ @azure-tools/typespec-azure-core/use-standard-operations Operation 'DeleteMultivariateModel' should be defined using a signature from the Azure.Core namespace.
    Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L65
    ⚠️ @azure-tools/typespec-azure-core/use-standard-operations Operation 'GetMultivariateModel' should be defined using a signature from the Azure.Core namespace.
    Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L80
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app-test
    Copy link
    Copy Markdown

    openapi-pipeline-app-test Bot commented Mar 24, 2023 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️~[Staging] ApiDocPreview succeeded [Detail] [Expand] 
     Please click here to preview with your @microsoft account.
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs] Generate from c211acfa56431d5dc0d7d6d901615329f7a4e5d5. SDK Automation 14.0.0 
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.3
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.3>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.3` to update!
cmderr	[automation_generate.sh] npm notice
    • ️✔️azure-contosowidgetmanager [View full logs]  [Preview SDK Changes] 
      info	[Changelog] data-plan skip changelog generation temporarily
    ️⚠️ azure-sdk-for-java warning [Detail]
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • ❌Code Generator Failed [Logs] Generate from c211acfa56431d5dc0d7d6d901615329f7a4e5d5. SDK Automation 14.0.0 
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mException: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:133
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 133 | �[0m             �[36;1mthrow "Not provide service name or namespace."�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mNot provide service name or namespace.
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1
warn	Skip package processing as generation is failed
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app-test
    Copy link
    Copy Markdown

    openapi-pipeline-app-test Bot commented Mar 24, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    TypeSpec AnomalyDetector https://apiviewstaging.azurewebsites.net/Assemblies/Review/4738ab15026d4566b085402b9c965b7d
    TypeSpec Contoso.WidgetManager https://apiviewstaging.azurewebsites.net/Assemblies/Review/1a211cbb307249e3ac5b4a0405a3a441
    Python azure-contosowidgetmanager https://apiviewstaging.azurewebsites.net/Assemblies/Review/b1e39da24f0f4bce8eb15b9edb1d4fc6
    Java azure-contoso-widgetmanager https://apiviewstaging.azurewebsites.net/Assemblies/Review/16cd8cc4957d4f529ccbc630aa21029a

    @workflow-bot-test
    Copy link
    Copy Markdown

    workflow-bot-test Bot commented Mar 24, 2023

    Hi @praveenkuttappan, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @workflow-bot-test
    Copy link
    Copy Markdown

    workflow-bot-test Bot commented Mar 24, 2023

    Hi @praveenkuttappan, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
     If you need further help, please feedback via swagger feedback.

    This was referenced Mar 24, 2023
    Closed
    Closed
    @praveenkuttappan
    Copy link
    Copy Markdown
    Author

    praveenkuttappan commented Mar 27, 2023

    /azp run

    @azure-pipelines
    Copy link
    Copy Markdown

    azure-pipelines Bot commented Mar 27, 2023

    No pipelines are associated with this pull request.

    @azure-sdk azure-sdk mentioned this pull request Mar 27, 2023
    Closed
    @praveenkuttappan praveenkuttappan deleted the Verify_typeSpec_Api_review_gen branch March 28, 2023 18:47
    @praveenkuttappan praveenkuttappan restored the Verify_typeSpec_Api_review_gen branch March 31, 2023 16:34
    @praveenkuttappan praveenkuttappan marked this pull request as draft March 31, 2023 17:24
    Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

    Reviewers

    @weshaggard weshaggard Awaiting requested review from weshaggard weshaggard will be requested when the pull request is marked ready for review weshaggard is a code owner

    @mikeharder mikeharder Awaiting requested review from mikeharder mikeharder will be requested when the pull request is marked ready for review mikeharder is a code owner

    @raych1 raych1 Awaiting requested review from raych1 raych1 will be requested when the pull request is marked ready for review raych1 is a code owner

    @maririos maririos Awaiting requested review from maririos maririos will be requested when the pull request is marked ready for review maririos is a code owner

    Assignees

    No one assigned

    Labels

    BreakingChangeReviewRequired cadl CI-FixRequiredOnFailure data-plane

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    3 participants

    @praveenkuttappan @konrad-jamrozik @AzureRestAPISpecReview