Skip to content

Comments

Add the missing x-ms-skip-url-encoding for some swagger specs#26194

Closed
magodo wants to merge 6 commits intomainfrom
scope_miss_url_encoding_skip
Closed

Add the missing x-ms-skip-url-encoding for some swagger specs#26194
magodo wants to merge 6 commits intomainfrom
scope_miss_url_encoding_skip

Conversation

@magodo
Copy link
Contributor

@magodo magodo commented Oct 12, 2023 •
edited
Loading

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Getting help

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 12, 2023 •
edited
Loading

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ The required check named Swagger SpellCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 12, 2023 •
edited
Loading

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand] 
There are no breaking changes.
compared swaggers (via Oad v0.10.4)] new version base version
advisor.json 2016-07-12-preview(7694e68) 2016-07-12-preview(main)
advisor.json 2017-03-31(7694e68) 2017-03-31(main)
advisor.json 2017-04-19(7694e68) 2017-04-19(main)
advisor.json 2020-01-01(7694e68) 2020-01-01(main)
advisor.json 2022-09-01(7694e68) 2022-09-01(main)
advisor.json 2022-10-01(7694e68) 2022-10-01(main)
advisor.json 2023-01-01(7694e68) 2023-01-01(main)
authorization-AccessReviewCalls.json 2021-12-01-preview(7694e68) 2021-12-01-preview(main)
scheduledActions.json 2022-06-01-preview(7694e68) 2022-06-01-preview(main)
costmanagement.json 2022-10-01-preview(7694e68) 2022-10-01-preview(main)
costmanagement.json 2022-10-05-preview(7694e68) 2022-10-05-preview(main)
costmanagement.json 2023-04-01-preview(7694e68) 2023-04-01-preview(main)
scheduledActions.json 2023-04-01-preview(7694e68) 2023-04-01-preview(main)
costmanagement.json 2022-10-01(7694e68) 2022-10-01(main)
scheduledActions.json 2022-10-01(7694e68) 2022-10-01(main)
costmanagement.json 2023-03-01(7694e68) 2023-03-01(main)
scheduledActions.json 2023-03-01(7694e68) 2023-03-01(main)
costmanagement.json 2023-08-01(7694e68) 2023-08-01(main)
scheduledActions.json 2023-08-01(7694e68) 2023-08-01(main)
settings.json 2023-08-01(7694e68) 2023-08-01(main)
serviceDiagnosticsSettings_API.json 2015-07-01(7694e68) 2015-07-01(main)
groupquota.json 2023-06-01-preview(7694e68) 2023-06-01-preview(main)
locks.json 2020-05-01(7694e68) 2020-05-01(main)
resources.json 2019-07-01(7694e68) 2019-07-01(main)
resources.json 2019-08-01(7694e68) 2019-08-01(main)
governanceAssignments.json 2022-01-01-preview(7694e68) 2022-01-01-preview(main)
governanceRules.json 2022-01-01-preview(7694e68) 2022-01-01-preview(main)
softwareplan.json 2019-06-01-preview(7694e68) 2019-06-01-preview(main)
softwareplan.json 2019-12-01(7694e68) 2019-12-01(main)
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand] 
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️⚠️Avocado: 3 Warnings warning [Detail]
Rule Message
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/authorization/resource-manager/readme.md
tag: specification/authorization/resource-manager/readme.md#tag-package-2022-05-01-preview
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/monitor/resource-manager/readme.md
tag: specification/monitor/resource-manager/readme.md#tag-package-2023-10
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/security/resource-manager/readme.md
tag: specification/security/resource-manager/readme.md#tag-package-composite-v3
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 103 Errors, 0 Warnings failed [Detail]

Only 30 items are listed, please refer to log for more details.

Rule Message
❌ INVALID_FORMAT Object didn't pass validation for format uuid: operationGUID
Url: Microsoft.Advisor/preview/2016-07-12-preview/advisor.json#L68:11
ExampleUrl: preview/2016-07-12-preview/examples/PollGenerateRecommendationsStatus.json#L4:20
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Operations_List.
Url: Microsoft.Advisor/preview/2016-07-12-preview/advisor.json#L152:14
❌ READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST ReadOnly property "id" cannot be sent in the request
Url: Microsoft.Advisor/preview/2016-07-12-preview/advisor.json#L533:15
ExampleUrl: preview/2016-07-12-preview/examples/CreateSuppression.json#L6:28
❌ READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST ReadOnly property "name" cannot be sent in the request
Url: Microsoft.Advisor/preview/2016-07-12-preview/advisor.json#L538:17
ExampleUrl: preview/2016-07-12-preview/examples/CreateSuppression.json#L5:13
❌ READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST ReadOnly property "type" cannot be sent in the request
Url: Microsoft.Advisor/preview/2016-07-12-preview/advisor.json#L543:17
ExampleUrl: preview/2016-07-12-preview/examples/CreateSuppression.json#L6:28
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Recommendations_GetGenerateStatus.
Url: Microsoft.Advisor/stable/2017-03-31/advisor.json#L58:14
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Operations_List.
Url: Microsoft.Advisor/stable/2017-03-31/advisor.json#L147:14
❌ INVALID_FORMAT Object didn't pass validation for format uuid: operationGUID
Url: Microsoft.Advisor/stable/2017-04-19/advisor.json#L304:11
ExampleUrl: stable/2017-04-19/examples/EmptyResponse.json#L4:20
❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Operations_List.
Url: Microsoft.Advisor/stable/2017-04-19/advisor.json#L388:14
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1235:35
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L33:33
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1235:35
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L34:27
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1235:35
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L35:30
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1235:35
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L36:34
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1235:35
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L79:33
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1235:35
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L80:27
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1235:35
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L81:30
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1235:35
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L82:34
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1163:37
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L46:33
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1163:37
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L47:27
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1163:37
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L48:30
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1163:37
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L49:34
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1163:37
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L92:33
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1163:37
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L93:27
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1163:37
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L94:30
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1163:37
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L95:34
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1172:35
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L22:31
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1172:35
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L23:24
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1172:35
ExampleUrl: stable/2020-01-01/examples/ListRecommendations.json#L24:28
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1235:35
ExampleUrl: stable/2020-01-01/examples/GetRecommendationDetail.json#L31:29
❌ INVALID_TYPE Expected type object but found type string
Url: Microsoft.Advisor/stable/2020-01-01/advisor.json#L1235:35
ExampleUrl: stable/2020-01-01/examples/GetRecommendationDetail.json#L32:23
️️✔️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 (MGID), please fix the error. See https://aka.ms/ci-fix#spell-check
path: Microsoft.Quota/preview/2023-06-01-preview/groupquota.json#L1701:118
️️✔️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?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 12, 2023 •
edited
Loading

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️❌SDK Breaking Change Tracking failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-net-track2 failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-python-track2 failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-sdk-for-java warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-go failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️🔄 azure-sdk-for-js inProgress [Detail]
️❌ azure-resource-manager-schemas failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-powershell warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-sdk-for-python warning [Detail]

Only 0 items are rendered, please refer to log for more details.

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 12, 2023 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Java azure-resourcemanager-advisor https://apiview.dev/Assemblies/Review/0a651c1697d54b32b2d0e142b9f4eac4?revisionId=a976a8dd345f47288d4885404a88ed0f
Java azure-resourcemanager-authorization-generated https://apiview.dev/Assemblies/Review/4da015cff3ae475db33a2cf2524bba24?revisionId=0211bcbe33714d13b858ce473acd3e07
Java azure-resourcemanager-monitor-generated https://apiview.dev/Assemblies/Review/c5eba455f3ab4ce4bf0c0a2da8091fce?revisionId=a519e737dab6471eb0cd8ad8c894f8d7
Java azure-resourcemanager-quota There is no API change compared with the previous version
Java azure-resourcemanager-resources-generated https://apiview.dev/Assemblies/Review/69d90a3c09dd41d388271d10f46fbed8?revisionId=b9e100f7657443178c8a5fa1f66f7577
Java azure-resourcemanager-softwareplan https://apiview.dev/Assemblies/Review/53fe2489816540f59f6df4f9f0339209?revisionId=d080e4f77bee43418221d5191d2bb6eb
.Net Azure.ResourceManager There is no API change compared with the previous version
.Net Azure.ResourceManager.Advisor https://apiview.dev/Assemblies/Review/d71844aea8af4a1480e7360f165b6b16?revisionId=f4fc302221b04631996c51844085fd2f
.Net Azure.ResourceManager.Authorization https://apiview.dev/Assemblies/Review/13cf5622d2e9478dba23390726492589?revisionId=2f8f90831efa449a852a58caba5e51fa
.Net Azure.ResourceManager.Monitor There is no API change compared with the previous version
.Net Azure.ResourceManager.Quota https://apiview.dev/Assemblies/Review/9eae2f6971e14eb38ccddc391596f535?revisionId=fac9713a1ad84c819fa75685a868519f
.Net Azure.ResourceManager.Resources https://apiview.dev/Assemblies/Review/9753d21bc98d4cdc976e592551787a03?revisionId=a4fe8cc9af4b496e95c0ba61d30cb34e

This was referenced Oct 12, 2023
Closed
Closed
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 12, 2023
This was referenced Oct 12, 2023
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Draft
@azure-sdk azure-sdk mentioned this pull request Oct 14, 2023
Draft
@magodo magodo requested a review from stankovski as a code owner October 15, 2023 06:38
This was referenced Oct 15, 2023
Closed
Closed
This was referenced Jan 2, 2024
Closed
Closed
Closed
Closed
@magodo magodo force-pushed the scope_miss_url_encoding_skip branch from e7d0759 to 70c0869 Compare January 5, 2024 08:50
@magodo magodo force-pushed the scope_miss_url_encoding_skip branch from 70c0869 to 7694e68 Compare January 12, 2024 07:06
@azure-sdk azure-sdk mentioned this pull request Jan 12, 2024
Closed
@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Jan 29, 2024
@magodo
Copy link
Contributor Author

magodo commented Feb 5, 2024

@rkmanda Would you please look at this PR as it has been hanging for 3 months and I'm about to leave it closed if no one from the swagger team gonna review it.

@microsoft-github-policy-service microsoft-github-policy-service bot removed the no-recent-activity There has been no recent activity on this issue. label Feb 5, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Feb 26, 2024
@magodo
Copy link
Contributor Author

magodo commented Feb 26, 2024

@rkmanda Would you please look at this PR as it has been hanging for 3 months and I'm about to leave it closed if no one from the swagger team gonna review it.

@microsoft-github-policy-service microsoft-github-policy-service bot removed the no-recent-activity There has been no recent activity on this issue. label Feb 26, 2024
@rkmanda
Copy link
Member

rkmanda commented Feb 26, 2024

@rkmanda Would you please look at this PR as it has been hanging for 3 months and I'm about to leave it closed if no one from the swagger team gonna review it.

The PR was signed off by ARM in October. The PR review workflow diagram calls out what you should have done to request a merge which clearly hasnt been followed. Please do the needful to request merge. The turnaround time for merges is 24 hours.

@rkmanda
Copy link
Member

rkmanda commented Feb 26, 2024

The go SDK check is also failing. So pl follow the documentation to get that to green or reach out to the owners to get an approval.

@rkmanda
Copy link
Member

rkmanda commented Feb 27, 2024

Do u have permission from these different RP owners to make this change on their behalf?

@magodo
Copy link
Contributor Author

magodo commented Feb 27, 2024

@rkmanda Thank you for your response. The background of my PR is that we have some internal tooling that will do something similar to the swagger live validation things, but not quite the same. During the processing, we identified these issues among different specs. You can find some latest versions of those specs have that missing tag added, which indicates they were leaked in the ARM review and this PR just fixes that up. IMO, there should be a linter to catch those issues at the first place.

As mentioned above, the CI failures flagged are not introduced by this PR, but just triggered by the it. I'd prefer not complicate this PR to involve not intended fixes.

WDYT?

@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Mar 18, 2024
@magodo
Copy link
Contributor Author

magodo commented Mar 18, 2024

@rkmanda

@microsoft-github-policy-service microsoft-github-policy-service bot removed the no-recent-activity There has been no recent activity on this issue. label Mar 18, 2024
@microsoft-github-policy-service
Copy link
Contributor

microsoft-github-policy-service bot commented Apr 1, 2024

Hi, @magodo. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Apr 1, 2024
@microsoft-github-policy-service
Copy link
Contributor

microsoft-github-policy-service bot commented Apr 15, 2024

Hi, @magodo. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stankovski stankovski Awaiting requested review from stankovski stankovski is a code owner

Assignees

@rkmanda rkmanda

Labels

Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go FixS360 no-recent-activity There has been no recent activity on this issue. ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@magodo @raych1 @weshaggard @rkmanda @AzureRestAPISpecReview @ms-zhenhua