Fix a spelling mistake on the paths. #19570
Merged
Conversation
This file contains hidden or 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, @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] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| Accounts.json | 2021-11-01(90e3ec6) | 2021-11-01(main) |
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/mediaServiceOperationStatuses/{operationId}' removed or restructured? Old: Microsoft.Media/stable/2021-11-01/Accounts.json#L1639:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/mediaServiceOperationResults/{operationId}' removed or restructured? Old: Microsoft.Media/stable/2021-11-01/Accounts.json#L1693:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.Media/stable/2021-11-01/Accounts.json#L1639:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.Media/stable/2021-11-01/Accounts.json#L1693:5 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-account-2021-11 | package-account-2021-11(90e3ec6) | package-account-2021-11(main) |
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
| The operation 'MediaServicesOperationResults_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/Accounts.json#L1694 |
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/stable/2021-11-01/Accounts.json#L298 |
|
| Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Media/stable/2021-11-01/Accounts.json#L882 |
|
| Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Media/stable/2021-11-01/Accounts.json#L1297 |
|
| Based on the response model schema, operation 'PrivateEndpointConnections_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Media/stable/2021-11-01/Accounts.json#L1391 |
|
| Guid used in model definition 'MediaServiceProperties' for property 'mediaServiceId'. 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/Accounts.json#L409 |
|
| Guid used in model definition 'MediaServiceIdentity' for property 'principalId'. 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/Accounts.json#L630 |
|
| 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/stable/2021-11-01/Accounts.json#L656 |
|
| 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/stable/2021-11-01/Accounts.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/stable/2021-11-01/Accounts.json#L196 |
|
| 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/stable/2021-11-01/Accounts.json#L302 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.Media/stable/2021-11-01/Accounts.json#L334 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: useSystemAssignedIdentity Location: Microsoft.Media/stable/2021-11-01/Accounts.json#L700 |
|
| 'name' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Media/stable/2021-11-01/Accounts.json#L1373 |
|
| 'name' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Media/stable/2021-11-01/Accounts.json#L1467 |
|
| 'name' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Media/stable/2021-11-01/Accounts.json#L1515 |
|
| 'name' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Media/stable/2021-11-01/Accounts.json#L1572 |
|
| 'storageAuthentication' 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/Accounts.json#L423 |
|
| 'ListEdgePoliciesInput' 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/Accounts.json#L569 |
|
| 'EdgeUsageDataEventHub' 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/Accounts.json#L578 |
|
| 'EdgeUsageDataCollectionPolicy' 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/Accounts.json#L595 |
|
| 'EdgePolicies' 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/Accounts.json#L616 |
|
| 'MediaServiceIdentity' 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/Accounts.json#L624 |
|
| 'UserAssignedManagedIdentity' 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/Accounts.json#L654 |
|
| 'KeyVaultProperties' 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/Accounts.json#L680 |
|
| 'ResourceIdentity' 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/Accounts.json#L694 |
|
| 'AccountEncryption' 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/Accounts.json#L710 |
|
| 'AccessControl' 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/Accounts.json#L753 |
|
| 'KeyDelivery' 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/Accounts.json#L787 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List all Media Services accounts Location: Microsoft.Media/stable/2021-11-01/Accounts.json#L1789 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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: 14 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > LiveOutputProperties > properties > hls)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > LiveEventInputAccessControl > properties > ip)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > LiveEventInput > properties > accessControl)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > LiveEventPreviewAccessControl > properties > ip)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > LiveEventPreview > properties > accessControl)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > LiveEventTranscription > properties > outputTranscriptionTrack)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > LiveEventProperties > properties > input)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > LiveEventProperties > properties > preview)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > LiveEventProperties > properties > encoding)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > LiveEventProperties > properties > crossSiteAccessPolicies)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > StreamingEndpointAccessControl > properties > akamai)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > StreamingEndpointAccessControl > properties > ip)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > StreamingEndpointProperties > properties > accessControl)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > StreamingEndpointProperties > properties > crossSiteAccessPolicies)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| 💬 | "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)" |
| 💬 | "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)" |
| 💬 | "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)" |
| 💬 | "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)" |
| 💬 | "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Autorest completed in 16.75s. 0 files generated." |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Using directive.0.suppress which is deprecated and will be removed in the future." |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Using directive.1.suppress which is deprecated and will be removed in the future." |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Using directive.2.suppress which is deprecated and will be removed in the future." |
|
| "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"Using directive.3.suppress which is deprecated and will be removed in the future." |
|
| 💬 | "readme":"mediaservices/resource-manager/readme.md", "tag":"package-account-2021-11", "details":"AutoRest core version selected from configuration: ^3.2.0." |
️️✔️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
|
|
NewApiVersionRequired reason: |
|
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. |
This was referenced Jun 23, 2022
Closed
JeffreyRichter
added
the
Approved-BreakingChange
allenjzhang
approved these changes
Jun 23, 2022
|
Newly checked in swagger correcting spelling on newly added operation path. SDK breaking change not a concern. |
This was referenced Jun 23, 2022
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.
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 appy 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 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.