-
Notifications
You must be signed in to change notification settings - Fork 5.5k
[Hub Generated] Review request for Microsoft.Media to add version preview/2021-11-01-preview #16089
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Hub Generated] Review request for Microsoft.Media to add version preview/2021-11-01-preview #16089
Conversation
|
Hi, @giakas Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Media/preview/2021-11-01-preview/VideoAnalyzers.json#L1200 |
|
| Based on the response model schema, operation 'PrivateEndpointConnections_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Media/preview/2021-11-01-preview/VideoAnalyzers.json#L1295 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'VideoAnalyzer', must have a list by immediate parent operation. Location: common-types/resource-management/v3/privatelinks.json#L20 |
|
| The child tracked resource, 'operationResults' with immediate parent 'PrivateEndpointConnection', must have a list by immediate parent operation. Location: common-types/resource-management/v3/privatelinks.json#L20 |
|
| The child tracked resource, 'privateLinkResources' with immediate parent 'VideoAnalyzer', must have a list by immediate parent operation. Location: common-types/resource-management/v3/privatelinks.json#L103 |
|
| The child tracked resource, 'pipelineTopologies' with immediate parent 'VideoAnalyzer', must have a list by immediate parent operation. Location: Microsoft.Media/preview/2021-11-01-preview/PipelineTopologies.json#L900 |
|
| The child tracked resource, 'livePipelines' with immediate parent 'VideoAnalyzer', must have a list by immediate parent operation. Location: Microsoft.Media/preview/2021-11-01-preview/PipelineTopologies.json#L1112 |
|
| The child tracked resource, 'pipelineJobs' with immediate parent 'VideoAnalyzer', must have a list by immediate parent operation. Location: Microsoft.Media/preview/2021-11-01-preview/PipelineTopologies.json#L1295 |
|
| The child tracked resource, 'operationStatuses' with immediate parent 'LivePipeline', must have a list by immediate parent operation. Location: Microsoft.Media/preview/2021-11-01-preview/PipelineTopologies.json#L1327 |
|
| The child tracked resource, 'operationStatuses' with immediate parent 'PipelineJob', must have a list by immediate parent operation. Location: Microsoft.Media/preview/2021-11-01-preview/PipelineTopologies.json#L1347 |
|
| The child tracked resource, 'operationStatuses' with immediate parent 'PrivateEndpointConnection', must have a list by immediate parent operation. Location: Microsoft.Media/preview/2021-11-01-preview/VideoAnalyzers.json#L811 |
|
| Guid used in model definition 'UserAssignedManagedIdentity' for property 'clientId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Media/preview/2021-11-01-preview/VideoAnalyzers.json#L621 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isInUse Location: Microsoft.Media/preview/2021-11-01-preview/Videos.json#L80 |
|
| 'LivePipelineOperationStatus' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Media/preview/2021-11-01-preview/PipelineTopologies.json#L1327 |
|
| 'PipelineJobOperationStatus' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Media/preview/2021-11-01-preview/PipelineTopologies.json#L1347 |
|
| 'VideoEntity' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Media/preview/2021-11-01-preview/Videos.json#L412 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Media/preview/2021-11-01-preview/VideoAnalyzers.json#L289 |
|
| Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Media/preview/2021-11-01-preview/VideoAnalyzers.json#L906 |
|
| Based on the response model schema, operation 'VideoAnalyzers_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Media/preview/2021-11-01-preview/VideoAnalyzers.json#L937 |
|
| Based on the response model schema, operation 'VideoAnalyzers_ListBySubscription' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Media/preview/2021-11-01-preview/VideoAnalyzers.json#L1788 |
|
| The child tracked resource, 'edgeModules' with immediate parent 'VideoAnalyzer', must have a list by immediate parent operation. Location: Microsoft.Media/preview/2021-11-01-preview/EdgeModules.json#L75 |
|
| The child tracked resource, 'videos' with immediate parent 'VideoAnalyzer', must have a list by immediate parent operation. Location: Microsoft.Media/preview/2021-11-01-preview/Videos.json#L412 |
|
| The child tracked resource, 'accessPolicies' with immediate parent 'VideoAnalyzer', must have a list by immediate parent operation. Location: Microsoft.Media/preview/2021-11-01-preview/Videos.json#L427 |
|
| Guid used in model definition 'EdgeModuleProperties' for property 'edgeModuleId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Media/preview/2021-11-01-preview/EdgeModules.json#L32 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: toBeExportedForShoebox Location: Microsoft.Media/preview/2021-11-01-preview/VideoAnalyzers.json#L64 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableRegionalMdmAccount Location: Microsoft.Media/preview/2021-11-01-preview/VideoAnalyzers.json#L193 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.Media/preview/2021-11-01-preview/VideoAnalyzers.json#L293 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: common-types/resource-management/v3/types.json#L626 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: canStream Location: Microsoft.Media/preview/2021-11-01-preview/Videos.json#L72 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: hasData Location: Microsoft.Media/preview/2021-11-01-preview/Videos.json#L76 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 24 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.0)
- current:preview/2021-11-01-preview/EdgeModules.json compared with base:preview/2021-05-01-preview/EdgeModules.json
- current:preview/2021-11-01-preview/VideoAnalyzers.json compared with base:preview/2021-05-01-preview/VideoAnalyzers.json
- current:preview/2021-11-01-preview/Videos.json compared with base:preview/2021-05-01-preview/Videos.json
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
Hi @giakas, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @giakas your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
...esource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/operations-list-all.json
Show resolved
Hide resolved
...resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-job-patch.json
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
![]()
|
@msyyc to confirm python SDK breaking change |
|
approve for python breaking change. |
…view/2021-11-01-preview (Azure#16089) * Adds base for updating Microsoft.Media from version preview/2021-05-01-preview to version 2021-11-01-preview * Updates readme * Updates API version in new specs and examples * Update to use 2021-11-01 version of the swaggers and examples * Remove unused examples and fix prettier errors. * fix patch where required is empty. * fix some lint errors * fix a json parse issue. * fix enum casing * fix missing 204 on endpointconnections delete * create entities for Patch operation * updating descriptions * fixed a bad commit. * fix validation errors * fix few more validation issues. * fix sample validaitons * fix examples * Update PrivateEndpoints to use v3 version of commonTypes to use systemData * change all commontypes to v3 * add long running operation to operations * update missing descriptions * fix a parameter name to operationId * Update few more descriptions * adding supressions for few failed validations * fix suppreesions * add few more descriptions
…view/2021-11-01-preview (Azure#16089) * Adds base for updating Microsoft.Media from version preview/2021-05-01-preview to version 2021-11-01-preview * Updates readme * Updates API version in new specs and examples * Update to use 2021-11-01 version of the swaggers and examples * Remove unused examples and fix prettier errors. * fix patch where required is empty. * fix some lint errors * fix a json parse issue. * fix enum casing * fix missing 204 on endpointconnections delete * create entities for Patch operation * updating descriptions * fixed a bad commit. * fix validation errors * fix few more validation issues. * fix sample validaitons * fix examples * Update PrivateEndpoints to use v3 version of commonTypes to use systemData * change all commontypes to v3 * add long running operation to operations * update missing descriptions * fix a parameter name to operationId * Update few more descriptions * adding supressions for few failed validations * fix suppreesions * add few more descriptions
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
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.
Please follow the link to find more details on PR review process.