-
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
Add New Api 2021-06-22 #14956
Add New Api 2021-06-22 #14956
Conversation
Hi, @Bhargava-Chary-Chollaty 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 |
---|---|
Per the Noun_Verb convention for Operation Ids, the noun 'HybridRunbookWorkers' 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.Automation/stable/2021-06-22/hybridRunbookWorker.json#L291 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'HybridRunbookWorkers_Create' Request Model: 'HybridRunbookWorkerCreateParameters' Response Model: 'HybridRunbookWorker' Location: Microsoft.Automation/stable/2021-06-22/hybridRunbookWorker.json#L154 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'HybridRunbookWorkerGroup_Create' Request Model: 'HybridRunbookWorkerGroupCreateOrUpdateParameters' Response Model: 'HybridRunbookWorkerGroup' Location: Microsoft.Automation/stable/2021-06-22/hybridRunbookWorkerGroup.json#L137 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridRunbookWorkerGroupModel'. Consider using the plural form of 'HybridRunbookWorkerGroup' 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.Automation/stable/2021-06-22/hybridRunbookWorkerGroup.json#L141 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth Location: Microsoft.Automation/stable/2021-06-22/account.json#L552 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth Location: Microsoft.Automation/stable/2021-06-22/account.json#L819 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.Automation/stable/2021-06-22/account.json#L886 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Automation/stable/2021-06-22/account.json#L84 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Automation/stable/2021-06-22/account.json#L142 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Automation/stable/2021-06-22/account.json#L185 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Automation/stable/2021-06-22/account.json#L228 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Automation/stable/2021-06-22/account.json#L270 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Automation/stable/2021-06-22/account.json#L310 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Automation/stable/2021-06-22/account.json#L365 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Automation/stable/2021-06-22/account.json#L413 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Automation/stable/2021-06-22/account.json#L458 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Automation/stable/2021-06-22/hybridRunbookWorkerGroup.json#L75 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Automation/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Automation/stable/2021-06-22/operations.json#L39 |
R4037 - MissingTypeObject |
The schema 'AutomationAccount' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L469 |
R4037 - MissingTypeObject |
The schema 'AutomationAccountProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L495 |
R4037 - MissingTypeObject |
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L563 |
R4037 - MissingTypeObject |
The schema 'AutomationAccountCreateOrUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L592 |
R4037 - MissingTypeObject |
The schema 'AutomationAccountCreateOrUpdateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L622 |
R4037 - MissingTypeObject |
The schema 'AutomationAccountListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L639 |
R4037 - MissingTypeObject |
The schema 'Statistics' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L655 |
R4037 - MissingTypeObject |
The schema 'StatisticsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L690 |
R4037 - MissingTypeObject |
The schema 'Usage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L702 |
R4037 - MissingTypeObject |
The schema 'UsageCounterName' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L733 |
R4037 - MissingTypeObject |
The schema 'UsageListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L746 |
R4037 - MissingTypeObject |
The schema 'Key' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L758 |
R4037 - MissingTypeObject |
The schema 'KeyListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L794 |
R4037 - MissingTypeObject |
The schema 'AutomationAccountUpdateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L805 |
R4037 - MissingTypeObject |
The schema 'AutomationAccountUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L826 |
R4037 - MissingTypeObject |
The schema 'Identity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L856 |
R4037 - MissingTypeObject |
The schema 'EncryptionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L904 |
R4037 - MissingTypeObject |
The schema 'identity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2021-06-22/account.json#L923 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/automation/resource-manager/readme.md tag: specification/automation/resource-manager/readme.md#tag-package-2020-01-13-preview |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️
Cross-Version Breaking Changes: 4 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.0)
- current:stable/2021-06-22/account.json compared with base:stable/2019-06-01/account.json
- current:stable/2021-06-22/account.json compared with base:preview/2020-01-13-preview/account.json
- current:stable/2021-06-22/hybridRunbookWorkerGroup.json compared with base:stable/2019-06-01/hybridRunbookWorkerGroup.json
- current:stable/2021-06-22/hybridRunbookWorkerGroup.json compared with base:preview/2020-01-13-preview/hybridRunbookWorkerGroup.json
- current:stable/2021-06-22/operations.json compared with base:stable/2019-06-01/operations.json
Rule | Message |
---|---|
The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/stable/2021-06-22/hybridRunbookWorkerGroup.json#L367:11 Old: Microsoft.Automation/stable/2019-06-01/hybridRunbookWorkerGroup.json#L301:11 |
|
The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/stable/2021-06-22/hybridRunbookWorkerGroup.json#L228:13 Old: Microsoft.Automation/stable/2019-06-01/hybridRunbookWorkerGroup.json#L169:13 |
The following breaking changes are detected by comparison with latest preview version:
Rule | Message |
---|---|
The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/stable/2021-06-22/hybridRunbookWorkerGroup.json#L367:11 Old: Microsoft.Automation/preview/2020-01-13-preview/hybridRunbookWorkerGroup.json#L301:11 |
|
The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/stable/2021-06-22/hybridRunbookWorkerGroup.json#L228:13 Old: Microsoft.Automation/preview/2020-01-13-preview/hybridRunbookWorkerGroup.json#L169:13 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
[Staging] SDK Track2 Validation: 6 Warnings warning [Detail]
- The following tags are being changed in this PR
- automation/resource-manager/readme.md#package-2015-10
- automation/resource-manager/readme.md#package-2017-05-preview
- automation/resource-manager/readme.md#package-2018-01-preview
- automation/resource-manager/readme.md#package-2018-06-preview
- automation/resource-manager/readme.md#package-2019-06
- automation/resource-manager/readme.md#package-2020-01-13-preview
- automation/resource-manager/readme.md#package-2021-06-22
Rule | Message |
---|---|
"readme":"automation/resource-manager/readme.md", "tag":"package-2015-10", "details":"The schema 'ScheduleCreateOrUpdateProperties-interval' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/schedule.json#/components/schemas/ScheduleCreateOrUpdateProperties-interval" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2015-10", "details":"The schema 'ScheduleProperties-interval' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/schedule.json#/components/schemas/ScheduleProperties-interval" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2019-06", "details":"The schema 'ScheduleCreateOrUpdateProperties-interval' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/schedule.json#/components/schemas/ScheduleCreateOrUpdateProperties-interval" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2019-06", "details":"The schema 'ScheduleProperties-interval' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/schedule.json#/components/schemas/ScheduleProperties-interval" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2020-01-13-preview", "details":"The schema 'ScheduleCreateOrUpdateProperties-interval' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/schedule.json#/components/schemas/ScheduleCreateOrUpdateProperties-interval" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2020-01-13-preview", "details":"The schema 'ScheduleProperties-interval' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/schedule.json#/components/schemas/ScheduleProperties-interval" |
|
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2015-10", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2015-10", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2021-06-22", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2021-06-22", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
PreCheck/DuplicateSchema |
"readme":"automation/resource-manager/readme.md", "tag":"package-2017-05-preview", "details":"Duplicate Schema named ScheduleProperties -- properties.interval.$ref: undefined => "#/components/schemas/schemas:756" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
AutorestCore/Exception |
"readme":"automation/resource-manager/readme.md", "tag":"package-2017-05-preview", "details":"Error: Plugin prechecker reported failure." |
PreCheck/DuplicateSchema |
"readme":"automation/resource-manager/readme.md", "tag":"package-2018-01-preview", "details":"Duplicate Schema named ScheduleProperties -- properties.interval.$ref: undefined => "#/components/schemas/schemas:605" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
AutorestCore/Exception |
"readme":"automation/resource-manager/readme.md", "tag":"package-2018-01-preview", "details":"Error: Plugin prechecker reported failure." |
PreCheck/DuplicateSchema |
"readme":"automation/resource-manager/readme.md", "tag":"package-2018-06-preview", "details":"Duplicate Schema named ScheduleProperties -- properties.interval.$ref: undefined => "#/components/schemas/schemas:503" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
AutorestCore/Exception |
"readme":"automation/resource-manager/readme.md", "tag":"package-2018-06-preview", "details":"Error: Plugin prechecker reported failure." |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2015-10", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2017-05-preview", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2017-05-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2018-01-preview", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2018-01-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2018-06-preview", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2018-06-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2019-06", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2019-06", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2020-01-13-preview", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"automation/resource-manager/readme.md", "tag":"package-2020-01-13-preview", "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
|
Hi, @Bhargava-Chary-Chollaty your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
"description": "Gets or sets hybrid runbook worker group create or update properties." | ||
}, | ||
"name": { | ||
"type": "string", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
name should be marked as readOnly. #Resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made the change
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Bhargava-Chary-Chollaty it's suggested to fix warnings for new api version in #14956 (comment) |
|
Hi, @Bhargava-Chary-Chollaty. 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 |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
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.