Update ACS Email swagger based on prior feedback from review board in preparation for GA

[apattath]

Data Plane API - Pull Request

Update ACS Email swagger based on prior feedback from review board in preparation for GA. We would like to release these changes in preview before we go to GA first.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your engagement record.

• Link to engagement record issue:

Is this review for (select one):

• [ ] a private preview
• [X] 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 Open API document (swagger) if applicable, and the root paths that have been updated.}

• Design Document: This is an incremental update.
• Previous Open API Doc: https://github.com/Azure/azure-rest-api-specs-pr/pull/4894, https://github.com/Azure/azure-rest-api-specs-pr/issues/4813
• Updated paths: specification\communication\data-plane\Email\preview\2021-10-01-preview\CommunicationServicesEmail.json

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

• 💬 Teams Channel
• 💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

• Open API validation tools were run on this PR. Go here to see how to fix errors
• Spectral Linting
• Open API Hub

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Azure DevTools Wiki

[openapi-workflow-bot[bot]]

Hi, @apattath Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

[openapi-pipeline-app[bot]]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️❌Breaking Change(Cross-Version): 1 Errors, 0 Warnings failed [Detail]

The following breaking changes are detected by comparison with the latest preview version:

Rule

Message

❌ Runtime Exception

"new":"https://github.com/Azure/azure-rest-api-specs/blob/2beb92d3d6c70d683183192bab3beac8bef09322/specification/communication/data-plane/Email/preview/2023-01-15-preview/CommunicationServicesEmail.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/communication/data-plane/Email/preview/2021-10-01-preview/CommunicationServicesEmail.json", "details":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.47/common/temp/node_modules/.pnpm/@[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=specification/communication/data-plane/Email/preview/2023-01-15-preview/CommunicationServicesEmail.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Schema violation: Data does not match any schemas from 'oneOf'\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/Email/preview/2023-01-15-preview/CommunicationServicesEmail.json:152:10 ($.paths["/emails:send"].post["x-ms-examples"]["Send Email"])\nERROR: Schema violation: Data does not match any schemas from 'oneOf'\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/Email/preview/2023-01-15-preview/CommunicationServicesEmail.json:62:10 ($.paths["/emails/operations/operationId"].get["x-ms-examples"]["G"

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 6 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2023-01-15-preview	package-2023-01-15-preview(2beb92d)	default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Email/preview/2023-01-15-preview/CommunicationServicesEmail.json#L20
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Email/preview/2023-01-15-preview/CommunicationServicesEmail.json#L40
:warning: ErrorResponse	Error schema should define code and message properties as required. Location: Email/preview/2023-01-15-preview/CommunicationServicesEmail.json#L40
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Email/preview/2023-01-15-preview/CommunicationServicesEmail.json#L125
:warning: ErrorResponse	Error schema should define code and message properties as required. Location: Email/preview/2023-01-15-preview/CommunicationServicesEmail.json#L125
:warning: EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Email/preview/2023-01-15-preview/CommunicationServicesEmail.json#L237

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView 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.

️️✔️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.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

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

[openapi-pipeline-app[bot]]

Generated ApiView

Language	Package Name	ApiView Link
swagger	communication-data-plane-Email	https://apiview.dev/Assemblies/Review/ee454eada3414e52b4fe4ab499d17e89

[openapi-workflow-bot[bot]]

Hi @apattath, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

[openapi-workflow-bot[bot]]

Hi, @apattath, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline

[openapi-workflow-bot[bot]]

Hi @apattath, 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. 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. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

[weidongxu-microsoft]

Would you link the issue of the review (the issue)? So I can check the log.

[ghost]

Hi, @apattath. 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 no-recent-activity label.

[mikekistler]

The Breaking Changes PR check is failing because of a bug in openapi-diff, so I will add the Approved-BreakingChange label.

[ruowan]

/azp run

[azure-pipelines[bot]]

Azure Pipelines successfully started running 1 pipeline(s).

[apattath]

@mikekistler - could you help merge this PR please?

[mikekistler]

@DominikMe @weidongxu-microsoft are you satisfied with the resolution to your comments? Is this good to merge? If so could you please put your approval on the PR?

[weidongxu-microsoft]

@mikekistler

I took another look and approved.

Added 2 comments. One "nit" that might affect codegen/SDK but won't block REST API. Another about whether we had result in action status monitor response. <-- ignore it if this is already discussed prior

[mikekistler]

@jhendrixMSFT I think this is ready to merge.