-
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
[Bug] - remove apiVersion from securityInsights common and targeting the ApiVersionParameter in the common-type #14641
[Bug] - remove apiVersion from securityInsights common and targeting the ApiVersionParameter in the common-type #14641
Conversation
…ersionParameter in the common-type
Hi, @ori-licht 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 |
---|---|
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'ApiVersion' removed or renamed? New: Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json#L126:3 Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json#L126:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'ApiVersion' removed or renamed? New: resource-manager/common/1.0/types.json#L80:3 Old: resource-manager/common/1.0/types.json#L80:3 |
1016 - ConstantStatusHasChanged |
The 'constant' status changed from the old version to the new. New: Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json#L41:9 Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json#L41:9 |
️⚠️
LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.SecurityInsights/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json#L37 |
'PUT' operation 'ProductSettings_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L185 |
|
Based on the response model schema, operation 'ProductSettings_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L38 |
|
Based on the response model schema, operation 'SentinelOnboardingStates_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json#L187 |
|
Sku Model definition 'Sku' is not valid. A Sku model must have 'name' property. It can also have 'tier', 'size', 'family', 'capacity' as optional properties. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L482 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SourceControlModel'. Consider using the plural form of 'SourceControl' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/SourceControls.json#L48 |
|
The child tracked resource, 'watchlistItems' with immediate parent 'Watchlist', must have a list by immediate parent operation. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L302 |
|
Guid used in model definition 'UserInfo' for property 'objectId'. 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.SecurityInsights/preview/2021-03-01-preview/Watchlists.json#L700 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L380 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L408 |
️️✔️
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 succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
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
|:speech_balloon: AutorestCore/Exception|"readme":"securityinsights/resource-manager/readme.md",
"tag":"package-2021-03-preview-only",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"securityinsights/resource-manager/readme.md",
"tag":"package-2021-03-preview-only",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"securityinsights/resource-manager/readme.md",
"tag":"package-2021-03-preview-only",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️
[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
|
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Hi @ori-licht, 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 is a bug fix, while all resources are targeting the commo-types, ApiVersionParameter, the operations is targeting an internal common, which is redundant. |
Hi, @ori-licht your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @raych1 |
Please make sure ARM API Review Checklist is marked correctly. The changes in the pr do not require a review by ARM. |
ok, thank you, I thought that the "BreakingChangeReviewRequired" tag indicates that is does. |
@ori-licht , changing api version parameter model is a braking change since the old one only accept a enum api-version value? Can you follow above action to get breaking change review approval? |
ohhh, now I have added that tag again, but this is a bug fix, the swagger is being generated incorrectly |
I also have this PR - #14659 |
Hi @raych1, Thank you |
…ersionParameter in the common-type (Azure#14641)
…ersionParameter in the common-type (Azure#14641)
…ersionParameter in the common-type
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.