-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Dev mediaservices microsoft.media 2021 11 01 #17540
Dev mediaservices microsoft.media 2021 11 01 #17540
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 |
---|---|
Per the Noun_Verb convention for Operation Ids, the noun 'Tracks' should not appear after the underscore. 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/2021-11-01/AssetsAndAssetFilters.json#L1778 |
|
Since operation 'StreamingEndpoints_Skus' 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/2021-11-01/streamingservice.json#L971 |
|
'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/2021-11-01/streamingservice.json#L971 |
|
The operation 'OperationResults_Get' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Media/stable/2021-11-01/AssetsAndAssetFilters.json#L1909 |
|
Based on the response model schema, operation 'StreamingEndpoints_Skus' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Media/stable/2021-11-01/streamingservice.json#L965 |
|
The child tracked resource, 'tracks' with immediate parent 'Asset', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/AssetsAndAssetFilters.json#L576 |
|
The child tracked resource, 'operationResults' with immediate parent 'AssetTrack', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/AssetsAndAssetFilters.json#L576 |
|
The child tracked resource, 'operationStatuses' with immediate parent 'AssetTrack', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/AssetsAndAssetFilters.json#L592 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: default Location: Microsoft.Media/stable/2021-11-01/AssetsAndAssetFilters.json#L434 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: forced Location: Microsoft.Media/stable/2021-11-01/AssetsAndAssetFilters.json#L438 |
|
'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/2021-11-01/streamingservice.json#L2065 |
|
'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/2021-11-01/streamingservice.json#L2088 |
|
'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/2021-11-01/streamingservice.json#L2090 |
|
'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/2021-11-01/streamingservice.json#L2102 |
The following errors/warnings exist before current PR submission:
Only 20 items are listed, please refer to log for more details.
Rule | Message |
---|---|
Per the Noun_Verb convention for Operation Ids, the noun 'Jobs' should not appear after the underscore. 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/2021-11-01/Encoding.json#L3153 |
|
Since operation 'Assets_GetEncryptionKey' 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/2021-11-01/AssetsAndAssetFilters.json#L1053 |
|
The child tracked resource, 'accountFilters' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/AccountFilters.json#L197 |
|
The child tracked resource, 'assets' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/AssetsAndAssetFilters.json#L224 |
|
The child tracked resource, 'assetFilters' with immediate parent 'Asset', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/AssetsAndAssetFilters.json#L412 |
|
The child tracked resource, 'contentKeyPolicies' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/ContentKeyPolicies.json#L769 |
|
The child tracked resource, 'transforms' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/Encoding.json#L1807 |
|
The child tracked resource, 'jobs' with immediate parent 'Transform', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/Encoding.json#L2423 |
|
The child tracked resource, 'streamingPolicies' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/StreamingPoliciesAndStreamingLocators.json#L378 |
|
The child tracked resource, 'streamingLocators' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/StreamingPoliciesAndStreamingLocators.json#L640 |
|
The child tracked resource, 'liveOutputs' with immediate parent 'LiveEvent', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/streamingservice.json#L1255 |
|
The child tracked resource, 'liveEvents' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/streamingservice.json#L1756 |
|
The child tracked resource, 'streamingEndpoints' with immediate parent 'MediaService', must have a list by immediate parent operation. Location: Microsoft.Media/stable/2021-11-01/streamingservice.json#L1988 |
|
Guid used in model definition 'AssetProperties' for property 'assetId'. 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/stable/2021-11-01/AssetsAndAssetFilters.json#L32 |
|
Guid used in model definition 'AssetFileEncryptionMetadata' for property 'assetFileId'. 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/stable/2021-11-01/AssetsAndAssetFilters.json#L120 |
|
Guid used in model definition 'AssetStreamingLocator' for property 'streamingLocatorId'. 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/stable/2021-11-01/AssetsAndAssetFilters.json#L203 |
|
Guid used in model definition 'ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier' for property 'keyId'. 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/stable/2021-11-01/ContentKeyPolicies.json#L82 |
|
Guid used in model definition 'ContentKeyPolicyOption' for property 'policyOptionId'. 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/stable/2021-11-01/ContentKeyPolicies.json#L698 |
|
Guid used in model definition 'ContentKeyPolicyProperties' for property 'policyId'. 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/stable/2021-11-01/ContentKeyPolicies.json#L727 |
|
Guid used in model definition 'StreamingLocatorContentKey' for property 'id'. 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/stable/2021-11-01/StreamingPoliciesAndStreamingLocators.json#L400 |
️⚠️
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-2021-11 |
️️✔️
~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross-Version Breaking Changes: 8 Errors, 152 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:stable/2021-11-01/AccountFilters.json compared with base:stable/2021-06-01/AccountFilters.json
- current:stable/2021-11-01/AccountFilters.json compared with base:preview/2019-05-01-preview/AccountFilters.json
- current:stable/2021-11-01/AssetsAndAssetFilters.json compared with base:stable/2021-06-01/AssetsAndAssetFilters.json
- current:stable/2021-11-01/AssetsAndAssetFilters.json compared with base:preview/2019-05-01-preview/AssetsAndAssetFilters.json
- current:stable/2021-11-01/ContentKeyPolicies.json compared with base:stable/2021-06-01/ContentKeyPolicies.json
- current:stable/2021-11-01/ContentKeyPolicies.json compared with base:preview/2019-05-01-preview/ContentKeyPolicies.json
- current:stable/2021-11-01/Encoding.json compared with base:stable/2021-06-01/Encoding.json
- current:stable/2021-11-01/Encoding.json compared with base:preview/2019-05-01-preview/Encoding.json
- current:stable/2021-11-01/StreamingPoliciesAndStreamingLocators.json compared with base:stable/2021-06-01/StreamingPoliciesAndStreamingLocators.json
- current:stable/2021-11-01/StreamingPoliciesAndStreamingLocators.json compared with base:preview/2019-05-01-preview/StreamingPoliciesAndStreamingLocators.json
- current:stable/2021-11-01/streamingservice.json compared with base:stable/2021-06-01/streamingservice.json
- current:stable/2021-11-01/streamingservice.json compared with base:preview/2019-05-01-preview/streamingservice.json
The following breaking changes are detected by comparison with latest preview version:
Only 20 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
- mediaservices/resource-manager/readme.md#package-2021-06
- mediaservices/resource-manager/readme.md#package-2021-05
- mediaservices/resource-manager/readme.md#package-2020-05
- mediaservices/resource-manager/readme.md#package-2020-02-preview
- mediaservices/resource-manager/readme.md#package-2019-09-preview
- mediaservices/resource-manager/readme.md#package-2019-05-preview
- mediaservices/resource-manager/readme.md#package-2018-07
- mediaservices/resource-manager/readme.md#package-2015-10
- mediaservices/resource-manager/readme.md#package-2018-03-preview
- mediaservices/resource-manager/readme.md#package-2018-06-preview
- mediaservices/resource-manager/readme.md#package-2021-11
Rule | Message |
---|---|
|
"readme":"mediaservices/resource-manager/readme.md", "tag":"package-2020-02-preview", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"mediaservices/resource-manager/readme.md", "tag":"package-2019-09-preview", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"mediaservices/resource-manager/readme.md", "tag":"package-2019-05-preview", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"mediaservices/resource-manager/readme.md", "tag":"package-2018-07", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"mediaservices/resource-manager/readme.md", "tag":"package-2018-06-preview", "details":"Error: Plugin prechecker reported failure." |
️️✔️
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).
Swagger Generation Artifacts
|
Hi @giakas, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @giakas, 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. |
NewApiVersionRequired reason: |
This reverts commit f1e9a60.
update api description
update example and description
@giakas , please add LRO headers for patch/delete 202 case. Somehow the error is not reported in case of deletion 202 case, we will investigate on this. |
* Adds base for updating Microsoft.Media from version stable/2021-06-01 to version 2021-11-01 * Updates readme * Updates API version in new specs and examples * Update Account swagger to 2021-11-01 * add the supressions * remove descriminator for Layers * use 2021-06-01 version for encoding service * remove 404 response * Revert "use 2021-06-01 version for encoding service" This reverts commit f1e9a60. * 202 for patch suprression * Update privateLinks to v3 to get systemData * Revert "Update privateLinks to v3 to get systemData" This reverts commit c43f857. * update streaming service and assetTracks swagger * fix lint errors. * fix some lint check. * rename examples * removing patch supression test * Update asset-tracks-operation-result-by-id-no-content.json * Update AssetsAndAssetFilters.json set x-ms-paging with null in list tracks * Update asset-tracks-operation-result-by-id-no-content.json remove 202 in post example * Update asset-tracks-operation-result-by-id.json add 202 back * Revert "removing patch supression test" This reverts commit f897922. * remove operation result data type * update description on a suppression. * add another path to the systemData suppression * update example and description * Update AssetsAndAssetFilters.json update api description * Add async headers to examples * add async headers to live event and streaming endpoint examples * Splitting Account service changes from this PR * remove unused account examples * Rebase with x-ms-identifier changes. * fix a lint error for x-ms-identifier Co-authored-by: zimao <[email protected]> Co-authored-by: Ziwei Mao <[email protected]>
New API version for Media services
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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 are using OpenAPIHub to initialize the PR for adding a new version. 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 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.