azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

[VideoTranslation] Initial add TypedSpec and swagger

Open DapengLi2016 opened this issue 1 year ago • 6 comments

Choose a PR Template

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

DapengLi2016 avatar Jun 25 '24 08:06 DapengLi2016

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
release_2024_05_20_preview release_2024_05_20_preview(4fc0922) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
:warning: OperationId OperationId for put method should contain both 'Create' and 'Update'
Location: VideoTranslation/preview/2024-05-20-preview/VideoTranslation.json#L224
:warning: OperationId OperationId for put method should contain both 'Create' and 'Update'
Location: VideoTranslation/preview/2024-05-20-preview/VideoTranslation.json#L471
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌SpellCheck: 1 Errors, 0 Warnings failed [Detail]
Rule Message
HowToFix Unknown word (videotranslation), please fix the error. See https://aka.ms/ci-fix#spell-check
path: VideoTranslation/preview/2024-05-20-preview/VideoTranslation.json#L24:33
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
Posted by Swagger Pipeline | How to fix these errors?

All the errors in check TypeSpec Validation are actually caused by the changes under folder VideoTranslation. Start by fixing this error:

tspconfig.yaml must define the following property:

linter:
  extends:
    - "@azure-tools/typespec-azure-rulesets/data-plane"

https://dev.azure.com/azure-sdk/public/_build/results?buildId=3904744&view=logs&j=011e1ec8-6569-5e69-4f06-baf193d1351e&t=0f4aa080-c997-58ca-481c-4930865ae0f8&l=1219

After this, I also think you have some formatting errors in your tsp files.

mikeharder avatar Jun 25 '24 17:06 mikeharder

This API version was reviewed and approved in private repo PR: https://github.com/Azure/azure-rest-api-specs-pr/pull/18399

mikekistler avatar Jun 28 '24 14:06 mikekistler