[Hub Generated] Review request for Microsoft.Media to add version stable/2022-08-01 #19891
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @StephanieHan 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] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| streamingservice.json | 2022-08-01(a7d44f1) | 2021-11-01(main) |
| streamingservice.json | 2022-08-01(a7d44f1) | 2019-05-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 18 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-08 | package-2022-08(a7d44f1) | default(main) |
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
| 'GET' operation 'LiveEvents_AsyncOperation' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L496 |
|
| 'GET' operation 'LiveEvents_OperationLocation' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L542 |
|
| 'GET' operation 'LiveOutputs_AsyncOperation' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L806 |
|
| 'GET' operation 'LiveOutputs_OperationLocation' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L852 |
|
| 'GET' operation 'StreamingEndpoints_AsyncOperation' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L1366 |
|
| 'GET' operation 'StreamingEndpoints_OperationLocation' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L1412 |
|
| The operation 'LiveEvents_OperationLocation' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L536 |
|
| The operation 'LiveOutputs_OperationLocation' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L846 |
|
| The operation 'StreamingEndpoints_OperationLocation' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L1406 |
|
| The child tracked resource, 'operationLocations' with immediate parent 'LiveOutput', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L1557 |
|
| The child tracked resource, 'operationLocations' with immediate parent 'LiveEvent', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L2058 |
|
| The child tracked resource, 'operationLocations' with immediate parent 'StreamingEndpoint', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L2290 |
|
| The child tracked resource, 'liveEventOperations' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L2417 |
|
| The child tracked resource, 'liveOutputOperations' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L2417 |
|
| The child tracked resource, 'streamingEndpointOperations' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L2417 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get the LiveEvent operation status Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L580 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get the LiveOutput operation status Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L893 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get the streaming endpoint operation status Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L1450 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Since operation 'StreamingEndpointsSkus' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L1170 |
|
| 'GET' operation 'StreamingEndpoints_Skus' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L1170 |
|
| Based on the response model schema, operation 'StreamingEndpoints_Skus' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L1164 |
|
| The child tracked resource, 'liveOutputs' with immediate parent 'LiveEvent', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L1557 |
|
| The child tracked resource, 'liveEvents' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L2058 |
|
| The child tracked resource, 'streamingEndpoints' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L2290 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: removeOutputsOnStop Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L1905 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: useStaticHostname Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L2005 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: cdnEnabled Location: Microsoft.Media/stable/2022-08-01/streamingservice.json#L2204 |
|
| 'scaleType' 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/stable/2022-08-01/streamingservice.json#L2367 |
|
| 'ArmStreamingEndpointSkuInfo' 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/stable/2022-08-01/streamingservice.json#L2390 |
|
| 'resourceType' 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/stable/2022-08-01/streamingservice.json#L2392 |
|
| 'StreamingEndpointSkuInfoListResult' 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/stable/2022-08-01/streamingservice.json#L2404 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/mediaservices/resource-manager/readme.md tag: specification/mediaservices/resource-manager/readme.md#tag-package-2022-08 |
️️✔️ApiReadinessCheck 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.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/a7d44f1ea0985443414729879ddfffad7579d7ab/specification/mediaservices/resource-manager/readme.md#tag-package-2022-08">mediaservices/resource-manager/readme.md#package-2022-08
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
This was referenced Jul 21, 2022
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @StephanieHan your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
|
this is the approved PR to private repo: link |
rkmanda
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
giakas
added
the
DoNotMerge
giakas
reviewed
Aug 1, 2022
...ices/resource-manager/Microsoft.Media/stable/2022-08-01/examples/async-operation-result.json
Show resolved
Hide resolved
giakas
reviewed
Aug 1, 2022
...iaservices/resource-manager/Microsoft.Media/stable/2022-08-01/examples/liveevent-update.json
Outdated
Show resolved
Hide resolved
giakas
reviewed
Aug 1, 2022
...ation/mediaservices/resource-manager/Microsoft.Media/stable/2022-08-01/streamingservice.json
Show resolved
Hide resolved
giakas
reviewed
Aug 2, 2022
...ation/mediaservices/resource-manager/Microsoft.Media/stable/2022-08-01/streamingservice.json
Outdated
Show resolved
Hide resolved
Generated ApiView
|
giakas
approved these changes
Aug 2, 2022
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
giakas
removed
the
DoNotMerge
This was referenced Aug 10, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Aug 10, 2022
…t.Media to add version stable/2022-08-01 (#2525) Create to sync Azure/azure-rest-api-specs#19891 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/mediaservices?expand=1)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] 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. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.