Skip to content

[ACS JobRouter][GA] Fix multiple grammatical errors#26695

Merged
tjprescott merged 3 commits intoAzure:mainfrom
sarkar-rajarshi:rsarkar/jobrouter/ga/fix-spec-grammatical-errors
Nov 14, 2023
Merged

[ACS JobRouter][GA] Fix multiple grammatical errors#26695
tjprescott merged 3 commits intoAzure:mainfrom
sarkar-rajarshi:rsarkar/jobrouter/ga/fix-spec-grammatical-errors

Conversation

@sarkar-rajarshi
Copy link
Copy Markdown
Member

@sarkar-rajarshi sarkar-rajarshi commented Nov 14, 2023

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.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

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.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

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 ApiView comment 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

@sarkar-rajarshi sarkar-rajarshi requested a review from a team as a code owner November 14, 2023 08:56
@sarkar-rajarshi sarkar-rajarshi requested review from tg-msft and weidongxu-microsoft and removed request for a team November 14, 2023 08:56
@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app bot commented Nov 14, 2023

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).

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app bot commented Nov 14, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
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
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L38
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L86
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L94
⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: eTag
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L105
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L139
⚠️ OperationId OperationId for patch method should contain both 'Create' and 'Update'
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L140
⚠️ PatchInOperationName '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
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L150
⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: eTag
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L176
⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: eTag
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L193
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L230
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L238
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L271
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L319
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L327
⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: eTag
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L338
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L372
⚠️ OperationId OperationId for patch method should contain both 'Create' and 'Update'
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L373
⚠️ PatchInOperationName '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
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L383
⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: eTag
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L409
⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: eTag
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L426
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L463
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L471
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L504
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L552
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L560
⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: eTag
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L571
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L605
⚠️ OperationId 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]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app bot commented Nov 14, 2023

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking


️❌ azure-sdk-for-net-track2 failed [Detail]
  • Failed [Logs]Release - Generate from d6d9527. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    warn		specification/communication/data-plane/JobRouter/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 131 | �[0m               �[36;1mGeneratePackage `�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 131 | �[0m               �[36;1mGeneratePackage `�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to packe sdk. exit code: False
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 807 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 131 | �[0m               �[36;1mGeneratePackage `�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
  • Azure.Communication.JobRouter [View full logs]  [Release SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from d6d9527. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    warn		specification/communication/data-plane/JobRouter/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh] npm notice
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.3
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.3>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.3` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️azure-communication-jobrouter [View full logs]  [Release SDK Changes]
    info	[Changelog] data-plan skip changelog generation temporarily
️❌ azure-sdk-for-java failed [Detail]
  • Failed [Logs]Release - Generate from d6d9527. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    warn		specification/communication/data-plane/JobRouter/readme.md skipped due to azure-sdk-for-java not found in swagger-to-sdk
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    cmderr	[generate.py]  WARN EBADENGINE Unsupported engine {
    cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/compiler@0.50.0',
    cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
    cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
    cmderr	[generate.py] npm WARN EBADENGINE }
    cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
    cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/rest@0.50.0',
    cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
    cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
    cmderr	[generate.py] npm WARN EBADENGINE }
    cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
    cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/http@0.50.0',
    cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
    cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
    cmderr	[generate.py] npm WARN EBADENGINE }
    cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
    cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/openapi@0.50.0',
    cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
    cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
    cmderr	[generate.py] npm WARN EBADENGINE }
    cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
    cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/versioning@0.50.0',
    cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
    cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
    cmderr	[generate.py] npm WARN EBADENGINE }
    cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
    cmderr	[generate.py] npm WARN EBADENGINE   package: '@azure-tools/typespec-azure-core@0.36.0',
    cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
    cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
    cmderr	[generate.py] npm WARN EBADENGINE }
    cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
    cmderr	[generate.py] npm WARN EBADENGINE   package: '@azure-tools/typespec-client-generator-core@0.36.0',
    cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
    cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
    cmderr	[generate.py] npm WARN EBADENGINE }
    cmderr	[generate.py] npm notice
    cmderr	[generate.py] npm notice New major version of npm available! 8.19.4 -> 10.2.3
    cmderr	[generate.py] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.3>
    cmderr	[generate.py] npm notice Run `npm install -g npm@10.2.3` to update!
    cmderr	[generate.py] npm notice
  • azure-communication-jobrouter [View full logs]  [Release SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from d6d9527. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    warn		specification/communication/data-plane/JobRouter/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    cmderr	[automation_generate.sh] [ERROR] Generate changelog failed: ENOENT: no such file or directory, open '/mnt/vss/_work/1/s/azure-sdk-for-js/sdk/communication/communication-job-router-rest/changelog-temp/package/CHANGELOG.md'
  • ️✔️@azure-rest/communication-job-router [View full logs]  [Release SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app bot commented Nov 14, 2023

Generated ApiView

Language Package Name ApiView Link
Python azure-communication-jobrouter There is no API change compared with the previous version
JavaScript @azure-rest/communication-job-router https://apiview.dev/Assemblies/Review/b3ee877a14ef41a28cd22d35f94dcfb5

Copy link
Copy Markdown
Member

@weidongxu-microsoft weidongxu-microsoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is only @doc

sarkar-rajarshi and others added 2 commits November 14, 2023 09:18
Co-authored-by: williamzhao87 <williamzhao87@users.noreply.github.com>
@tjprescott tjprescott enabled auto-merge (squash) November 14, 2023 17:26
@tjprescott tjprescott merged commit d6d9527 into Azure:main Nov 14, 2023
@openapi-pipeline-app
Copy link
Copy Markdown

Swagger pipeline restarted successfully, please wait for status update in this comment.

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants