-
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
Guest Configuration: Fix S360 Swagger spec correctness and Linter errors #17319
Conversation
* Add new 2.0-preview.1 version for IoT Central * fix typo on enum value * rollback 1.0 changes, applied 2.0-preview.1 * fix typo * remove non-used examples * fix style * update version from 2.0-preview.1 to 1.1-preview * update code review comments, fix patch consumes with json-patch support, fix examples for fileupload * add nextLink to collection of orgs * fix typo * fix wrong position of paging * fix the paging * add . to description * update default to use enum for api-version * add oct release with query, cde v2, device filter, device template filter, relationship, edge template, simplified template patching * update examples * fix lint error, model validation * fix missing type in examples, remove url format * fix ID case * fix id case * fix ID case * add iotc query language reference * fix typo
Hi, @aashish1987 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. vsswagger@microsoft.com |
[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 |
---|---|
1045 - AddedOptionalProperty |
The new version has a new optional property 'resourceType' that was not found in the old version. New: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1021:7 Old: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1021:7 |
️⚠️
LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R2020 - RequiredPropertiesMissingInResourceModel |
Model definition 'GuestConfigurationAssignment' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L867 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L184 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L624 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.GuestConfiguration/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L811 |
R4037 - MissingTypeObject |
The schema 'GuestConfigurationAssignmentList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L855 |
R4037 - MissingTypeObject |
The schema 'GuestConfigurationAssignment' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L867 |
R4037 - MissingTypeObject |
The schema 'GuestConfigurationNavigation' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L882 |
R4037 - MissingTypeObject |
The schema 'ConfigurationParameter' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L952 |
R4037 - MissingTypeObject |
The schema 'ConfigurationSetting' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L967 |
R4037 - MissingTypeObject |
The schema 'GuestConfigurationAssignmentProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1020 |
R4037 - MissingTypeObject |
The schema 'GuestConfigurationAssignmentReportList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1102 |
R4037 - MissingTypeObject |
The schema 'GuestConfigurationAssignmentReport' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1114 |
R4037 - MissingTypeObject |
The schema 'GuestConfigurationAssignmentReportProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1133 |
R4037 - MissingTypeObject |
The schema 'AssignmentInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1187 |
R4037 - MissingTypeObject |
The schema 'VMInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1201 |
R4037 - MissingTypeObject |
The schema 'ConfigurationInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1216 |
R4037 - MissingTypeObject |
The schema 'AssignmentReportDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1231 |
R4037 - MissingTypeObject |
The schema 'AssignmentReportResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1287 |
R4037 - MissingTypeObject |
The schema 'AssignmentReportResourceComplianceReason' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1318 |
R4037 - MissingTypeObject |
The schema 'VMSSVMInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1333 |
R4037 - MissingTypeObject |
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/common/v1/definitions.json#L27 |
R4037 - MissingTypeObject |
The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/common/v1/definitions.json#L142 |
R4037 - MissingTypeObject |
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/common/v1/definitions.json#L121 |
R4037 - MissingTypeObject |
The schema 'OperationList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/common/v1/definitions.json#L154 |
Since operation 'GuestConfigurationAssignments_SubscriptionList' response has model definition 'x-ms-pageable', 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.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L208 |
|
Since operation 'GuestConfigurationAssignments_RGList' response has model definition 'x-ms-pageable', 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.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L256 |
|
'GET' operation 'GuestConfigurationAssignments_SubscriptionList' 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.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L208 |
|
'GET' operation 'GuestConfigurationAssignments_RGList' 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.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L256 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1126 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L1310 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
~[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 succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️
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 @aashish1987, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @aashish1987, 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: |
Hi, @aashish1987. 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 |
waiting for breaking change meeting |
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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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.