[Azure.Communication.Services][JobRouter] Modify swagger after SDK review #19750
Conversation
This file contains 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, @sarkar-rajarshi 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| communicationservicejobrouter.json | 2022-07-18(c988c8c) | 2021-10-20-preview2(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-jobrouter-2022-07-18-preview | package-jobrouter-2022-07-18-preview(c988c8c) | default(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| The operation 'JobRouter_CloseJobAction' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json#L869 |
️️✔️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: 28 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/c988c8cf8341e763aabe934e3afa3abe96bf71ce/specification/communication/data-plane/JobRouter/readme.md#tag-package-jobrouter-2022-07-18-preview">communication/data-plane/JobRouter/readme.md#package-jobrouter-2022-07-18-preview
| Rule | Message |
|---|---|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'BestWorkerMode' has a property 'kind' that is already declared the parent schema 'DistributionMode' but isn't significantly different. The property has been removed from BestWorkerMode" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'CancelExceptionAction' has a property 'kind' that is already declared the parent schema 'ExceptionAction' but 'readonly' has been changed -- this is not permitted. The property has been removed from CancelExceptionAction" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'ConditionalQueueSelectorAttachment' has a property 'kind' that is already declared the parent schema 'QueueSelectorAttachment' but 'readonly' has been changed -- this is not permitted. The property has been removed from ConditionalQueueSelectorAttachment" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'ConditionalWorkerSelectorAttachment' has a property 'kind' that is already declared the parent schema 'WorkerSelectorAttachment' but 'readonly' has been changed -- this is not permitted. The property has been removed from ConditionalWorkerSelectorAttachment" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'DirectMapRule' has a property 'kind' that is already declared the parent schema 'RouterRule' but isn't significantly different. The property has been removed from DirectMapRule" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'ExpressionRule' has a property 'kind' that is already declared the parent schema 'RouterRule' but isn't significantly different. The property has been removed from ExpressionRule" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'FunctionRule' has a property 'kind' that is already declared the parent schema 'RouterRule' but isn't significantly different. The property has been removed from FunctionRule" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'LongestIdleMode' has a property 'kind' that is already declared the parent schema 'DistributionMode' but isn't significantly different. The property has been removed from LongestIdleMode" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'ManualReclassifyExceptionAction' has a property 'kind' that is already declared the parent schema 'ExceptionAction' but 'readonly' has been changed -- this is not permitted. The property has been removed from ManualReclassifyExceptionAction" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'PassThroughQueueSelectorAttachment' has a property 'kind' that is already declared the parent schema 'QueueSelectorAttachment' but 'readonly' has been changed -- this is not permitted. The property has been removed from PassThroughQueueSelectorAttachment" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'PassThroughWorkerSelectorAttachment' has a property 'kind' that is already declared the parent schema 'WorkerSelectorAttachment' but 'readonly' has been changed -- this is not permitted. The property has been removed from PassThroughWorkerSelectorAttachment" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'QueueLengthExceptionTrigger' has a property 'kind' that is already declared the parent schema 'JobExceptionTrigger' but isn't significantly different. The property has been removed from QueueLengthExceptionTrigger" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'ReclassifyExceptionAction' has a property 'kind' that is already declared the parent schema 'ExceptionAction' but 'readonly' has been changed -- this is not permitted. The property has been removed from ReclassifyExceptionAction" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'RoundRobinMode' has a property 'kind' that is already declared the parent schema 'DistributionMode' but isn't significantly different. The property has been removed from RoundRobinMode" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'RuleEngineQueueSelectorAttachment' has a property 'kind' that is already declared the parent schema 'QueueSelectorAttachment' but 'readonly' has been changed -- this is not permitted. The property has been removed from RuleEngineQueueSelectorAttachment" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'RuleEngineWorkerSelectorAttachment' has a property 'kind' that is already declared the parent schema 'WorkerSelectorAttachment' but 'readonly' has been changed -- this is not permitted. The property has been removed from RuleEngineWorkerSelectorAttachment" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'StaticQueueSelectorAttachment' has a property 'kind' that is already declared the parent schema 'QueueSelectorAttachment' but 'readonly' has been changed -- this is not permitted. The property has been removed from StaticQueueSelectorAttachment" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'StaticRule' has a property 'kind' that is already declared the parent schema 'RouterRule' but isn't significantly different. The property has been removed from StaticRule" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'StaticWorkerSelectorAttachment' has a property 'kind' that is already declared the parent schema 'WorkerSelectorAttachment' but 'readonly' has been changed -- this is not permitted. The property has been removed from StaticWorkerSelectorAttachment" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'WaitTimeExceptionTrigger' has a property 'kind' that is already declared the parent schema 'JobExceptionTrigger' but isn't significantly different. The property has been removed from WaitTimeExceptionTrigger" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'WeightedAllocationQueueSelectorAttachment' has a property 'kind' that is already declared the parent schema 'QueueSelectorAttachment' but 'readonly' has been changed -- this is not permitted. The property has been removed from WeightedAllocationQueueSelectorAttachment" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"Schema 'WeightedAllocationWorkerSelectorAttachment' has a property 'kind' that is already declared the parent schema 'WorkerSelectorAttachment' but 'readonly' has been changed -- this is not permitted. The property has been removed from WeightedAllocationWorkerSelectorAttachment" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"The schema 'components·1p0tdsy·schemas·routerjob·properties·labels·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json#/components/schemas/components·1p0tdsy·schemas·routerjob·properties·labels·additionalproperties" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"The schema 'components·yagnnw·schemas·routerjob·properties·tags·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json#/components/schemas/components·yagnnw·schemas·routerjob·properties·tags·additionalproperties" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"The schema 'components·1m2sa7r·schemas·jobqueue·properties·labels·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json#/components/schemas/components·1m2sa7r·schemas·jobqueue·properties·labels·additionalproperties" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"The schema 'components·1un595a·schemas·routerworker·properties·labels·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json#/components/schemas/components·1un595a·schemas·routerworker·properties·labels·additionalproperties" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"The schema 'components·1jvpl8p·schemas·routerworker·properties·tags·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json#/components/schemas/components·1jvpl8p·schemas·routerworker·properties·tags·additionalproperties" |
|
| "readme":"communication/data-plane/JobRouter/readme.md", "tag":"package-jobrouter-2022-07-18-preview", "details":"The schema 'components·1oe3kee·schemas·reclassifyexceptionaction·properties·labelstoupsert·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json#/components/schemas/components·1oe3kee·schemas·reclassifyexceptionaction·properties·labelstoupsert·additionalproperties" |
️️✔️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 pipeline restarted successfully, please wait for status update in this comment. |
|
NewApiVersionRequired reason: |
|
Hi @sarkar-rajarshi, 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. |
|
Hi @sarkar-rajarshi, Your PR has some issues. Please fix the CI sequentially by following the order of
|
sarkar-rajarshi
requested review from
BlackRider97 and
weidongxu-microsoft
and removed request for
a team
...nication/data-plane/JobRouter/preview/2021-10-20-preview2/communicationservicejobrouter.json
Outdated
Show resolved
Hide resolved
williamzhao87
approved these changes
Jul 13, 2022
sarkar-rajarshi
changed the title
sarkar-rajarshi
force-pushed
the
feature/acs_router/sdk-review-comments
branch
from
628e9b5
to
c988c8c
Compare
|
@anuchandy can we get this merged? |
|
Do we have a diff between 2 versions? We might want to do a final check if there is other REST API change (other than "thresholdSeconds") between 2 versions. |
|
@weidongxu-microsoft
|
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.