Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add Azure Communication Services Email data plane API #19178

Merged
merged 3 commits into from
May 23, 2022
Merged

Add Azure Communication Services Email data plane API #19178

merged 3 commits into from
May 23, 2022

Conversation

apattath
Copy link
Contributor

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:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] 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.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

@apattath apattath requested a review from a team as a code owner May 23, 2022 04:56
@apattath apattath requested review from BlackRider97 and mikekistler and removed request for a team May 23, 2022 04:56
@openapi-workflow-bot
Copy link

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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 23, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Email_Send' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Email/preview/2021-10-01-preview/CommunicationServicesEmail.json#L68
    ️️✔️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.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️❌PoliCheck: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 23, 2022 •
    edited
    Loading

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

    @openapi-workflow-bot
    Copy link

    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.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
     If you need further help, please feedback via swagger feedback.

    @jhendrixMSFT jhendrixMSFT merged commit 92cf370 into Azure:main May 23, 2022
    gargankit-microsoft pushed a commit that referenced this pull request May 26, 2022
    @apattath @gargankit-microsoft
    Add Azure Communication Services Email data plane API (#19178)
    9b438db 
    * Add Azure Communication Services Email data plane API

* update SendMail.json to use 'CC' property

* Add suppression for linter rule DefinitionsPropertiesNamesCamelCase for CC proprety
    gerrytan pushed a commit to gerrytan/azure-rest-api-specs that referenced this pull request Sep 6, 2024
    @magodo @gerrytan
    exportTerraform: Change resourceId -> resourceIds; Add `maskSensitive…
    fa992ed 
    …`; Change `fullConfig` defaults (Azure#19178)

* exportTerraform: Change resourceId -> resourceIds; Add `maskSensitive`; Change `fullConfig` defaults

* rename

* rename

* rename
    gerrytan added a commit that referenced this pull request Sep 20, 2024
    @gerrytan @magodo
    New RP Microsoft.AzureTerraform.Management - export Azure resources t…
    46b3863 
    …o Terraform HCL (#30455)

* New RP: Microsoft.AzureTerraform (ver=2023-07-01-preview)

* prettier

* remove x-ms-discriminator-value

* readme.md: add `openapi-subtype`

* Fix LintDiff failure

* Result configuration type change from object to string

* Remove properties: `subscriptionId` and `environment`

* Change `errors` from list of string to list of `ErrorResponse`

* Add operations endpoint

* Update

* Update

* AzureTerraform RP: Sync the MS version with the private version

* Terraform: Change `exportEerraform` endpoint to LRO (#18782)

* terraform: Modify the `exportTerraform` RT to be LRO

* Update

* prettier

* spell

* CI validation

* More CI issue fixes

* typo

* Add readme.go.md

* typo

* prettier

* suppression

* Update suppression

* AzureTerrform: Remove the parallelism property (#18909)

* exportTerraform: Change resourceId -> resourceIds; Add `maskSensitive`; Change `fullConfig` defaults (#19178)

* exportTerraform: Change resourceId -> resourceIds; Add `maskSensitive`; Change `fullConfig` defaults

* rename

* rename

* rename

* Specify LRO model (#19401)

* Add up the `resourceId` in `OperationStatus` model (#19450)

* Add `uri` format (#19455)

* Add format url

* update

* TypeSpec for Microsoft.AzureTerraform (#19390)

* TypeSpec for Microsoft.AzureTerraform

* Sorted swagger file, and added typespec generated with tsp-client

* revert export.json in prep of merging

* Sorted export.json for easy diff on future typespec -> swagger

* Rerun swagger -> typespec conversion after merging latest RPSaaSMaster,
updated namespace

* tsp compile for TypeSpec -> swagger

* Refactored typescript to minimise swagger diff

* Spread ErrorResponse into OperationStatus model

* Fixed enums, use doc decorator

* Update exportTerraform path desc

* Update doc for ExportResource model

* LintDiff fix: remove unnecessary auth

* Add resourceId prop to OperationStatus model, fixed char casing so they're consistent throughout

* Made resourceId read only

* Check `Swagger BreakingChange`: minimise diff on x-ms-enum

* TypeSpec Validation fix: rename dir and add missing @doc

* Upgrade/rp tsp 0.60 (#19551) -- applying only for specification/terraform

* Revert accidental changes to cSpell.json while merging

* Added tf files used for armstrong testing

---------

Co-authored-by: magodo <wztdyl@sina.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @jhendrixMSFT jhendrixMSFT jhendrixMSFT approved these changes

    @BlackRider97 BlackRider97 Awaiting requested review from BlackRider97 BlackRider97 is a code owner automatically assigned from Azure/api-stewardship-board

    @mikekistler mikekistler Awaiting requested review from mikekistler mikekistler is a code owner automatically assigned from Azure/api-stewardship-board

    Assignees

    @tjprescott tjprescott

    @jhendrixMSFT jhendrixMSFT

    Labels
    None yet
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @apattath @jhendrixMSFT @tjprescott