[ACS JobRouter][GA] Fix multiple grammatical errors#26695
Merged
tjprescott merged 3 commits intoAzure:mainfrom Nov 14, 2023
Merged
Conversation
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| communicationservicejobrouter.json | 2023-11-01(118b5cc) | 2023-11-01(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️🔄CredScan inProgress [Detail]
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-jobrouter-2023-11-01 | package-jobrouter-2023-11-01(118b5cc) | package-jobrouter-2023-11-01(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L38 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L86 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L94 |
|
| Schema with type: string has unrecognized format: eTag Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L105 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L139 |
|
| OperationId for patch method should contain both 'Create' and 'Update' Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L140 |
|
| 'PATCH' operation 'JobRouterAdministrationOperations_UpsertClassificationPolicy' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L140 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L150 |
|
| Schema with type: string has unrecognized format: eTag Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L176 |
|
| Schema with type: string has unrecognized format: eTag Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L193 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L230 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L238 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L271 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L319 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L327 |
|
| Schema with type: string has unrecognized format: eTag Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L338 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L372 |
|
| OperationId for patch method should contain both 'Create' and 'Update' Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L373 |
|
| 'PATCH' operation 'JobRouterAdministrationOperations_UpsertDistributionPolicy' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L373 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L383 |
|
| Schema with type: string has unrecognized format: eTag Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L409 |
|
| Schema with type: string has unrecognized format: eTag Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L426 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L463 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L471 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L504 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L552 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L560 |
|
| Schema with type: string has unrecognized format: eTag Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L571 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L605 |
|
| OperationId for patch method should contain both 'Create' and 'Update' Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L606 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️🔄PoliCheck inProgress [Detail]
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Nov 14, 2023
williamzhao87
approved these changes
Nov 14, 2023
Co-authored-by: williamzhao87 <williamzhao87@users.noreply.github.com>
tjprescott
approved these changes
Nov 14, 2023
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
This was referenced Nov 14, 2023
Closed
zman-ms
pushed a commit
that referenced
this pull request
Jan 10, 2024
* Fix multiple grammatical errors * Update specification/communication/Communication.JobRouter/main.tsp Co-authored-by: williamzhao87 <williamzhao87@users.noreply.github.com> * fix spec validation error --------- Co-authored-by: williamzhao87 <williamzhao87@users.noreply.github.com>
This file contains hidden or 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
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.
Data Plane API - Pull Request
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
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 ApiViewcomment 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.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links