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.

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

[Communication] - SDK - Rename folders to be more consistent with other services #14366

Merged
merged 3 commits into from
May 19, 2021

Conversation

JoshuaLai
Copy link
Member

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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.

@openapi-workflow-bot
Copy link

Hi, @JoshuaLai 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 11, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌LintDiff: 30 Errors, 10 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    AutoRest exception "readme":"communication/data-plane/Chat/readme.md",
    "tag":"package-chat-2021-04-05-preview6",
    "details":"Referenced file 'file:///home/vsts/work/1/azure-rest-api-specs/specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json' not found"
    AutoRest exception "readme":"communication/data-plane/Chat/readme.md",
    "tag":"package-chat-2021-04-05-preview6",
    "details":"swagger-document/loader - FAILED"
    AutoRest exception "readme":"communication/data-plane/Chat/readme.md",
    "tag":"package-chat-2021-04-05-preview6",
    "details":"Error: [OperationAbortedException] Error occurred. Exiting."
    AutoRest exception "readme":"communication/data-plane/Chat/readme.md",
    "tag":"package-chat-2021-03-07",
    "details":"Referenced file 'file:///home/vsts/work/1/azure-rest-api-specs/specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json' not found"
    AutoRest exception "readme":"communication/data-plane/Chat/readme.md",
    "tag":"package-chat-2021-03-07",
    "details":"swagger-document/loader - FAILED"
    AutoRest exception "readme":"communication/data-plane/Chat/readme.md",
    "tag":"package-chat-2021-03-07",
    "details":"Error: [OperationAbortedException] Error occurred. Exiting."
    AutoRest exception "readme":"communication/data-plane/Chat/readme.md",
    "tag":"package-2021-03-01-preview5",
    "details":"Referenced file 'file:///home/vsts/work/1/azure-rest-api-specs/specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json' not found"
    AutoRest exception "readme":"communication/data-plane/Chat/readme.md",
    "tag":"package-2021-03-01-preview5",
    "details":"swagger-document/loader - FAILED"
    AutoRest exception "readme":"communication/data-plane/Chat/readme.md",
    "tag":"package-2021-03-01-preview5",
    "details":"Error: [OperationAbortedException] Error occurred. Exiting."
    AutoRest exception "readme":"communication/data-plane/Chat/readme.md",
    "tag":"package-2021-01-27-preview4",
    "details":"Referenced file 'file:///home/vsts/work/1/azure-rest-api-specs/specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json' not found"
    ️❌Avocado: 40 Errors, 4 Warnings failed [Detail]

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: data-plane/Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/examples
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: data-plane/Microsoft.CommunicationServicesChat/preview/2021-01-27-preview4
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: Microsoft.CommunicationServicesChat/preview/2021-01-27-preview4/examples
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: data-plane/Microsoft.CommunicationServicesChat/preview/2021-03-01-preview5
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: Microsoft.CommunicationServicesChat/preview/2021-03-01-preview5/examples
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: data-plane/Microsoft.CommunicationServicesChat/preview/2021-04-05-preview6
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: Microsoft.CommunicationServicesChat/preview/2021-04-05-preview6/examples
    ️❌ModelValidation: 10 Errors, 0 Warnings failed [Detail]
    Rule Message
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/preview/2020-11-19-preview1/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/preview/2020-11-19-preview1/common.json') "role":"Model Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Chat/preview/2020-11-01-preview3/communicationserviceschat.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Model Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Chat/preview/2021-01-27-preview4/communicationserviceschat.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Model Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Chat/preview/2021-03-01-preview5/communicationserviceschat.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Model Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Chat/preview/2021-04-05-preview6/communicationserviceschat.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Model Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Chat/stable/2021-03-07/communicationserviceschat.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Model Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Identity/preview/2021-02-22-preview1/CommunicationIdentity.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Model Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Identity/preview/2021-03-31-preview1/CommunicationIdentity.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Model Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Identity/stable/2021-03-07/CommunicationIdentity.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Model Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/PhoneNumbers/stable/2021-03-07/phonenumbers.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Model Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Turn/preview/2021-02-22-preview1/CommunicationTurn.json"
    ️❌SemanticValidation: 10 Errors, 0 Warnings failed [Detail]
    Rule Message
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/preview/2020-11-19-preview1/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/preview/2020-11-19-preview1/common.json') "role":"Semantic Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Chat/preview/2020-11-01-preview3/communicationserviceschat.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Semantic Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Chat/preview/2021-01-27-preview4/communicationserviceschat.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Semantic Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Chat/preview/2021-03-01-preview5/communicationserviceschat.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Semantic Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Chat/preview/2021-04-05-preview6/communicationserviceschat.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Semantic Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Chat/stable/2021-03-07/communicationserviceschat.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Semantic Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Identity/preview/2021-02-22-preview1/CommunicationIdentity.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Semantic Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Identity/preview/2021-03-31-preview1/CommunicationIdentity.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Semantic Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Identity/stable/2021-03-07/CommunicationIdentity.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Semantic Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/PhoneNumbers/stable/2021-03-07/phonenumbers.json"
    internal error: Failed to load a reference file specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json. (Error: ENOENT: no such file or directory, open 'specification/communication/data-plane/Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json') "role":"Semantic Validation",
    "url":"https://github.com/Azure/azure-rest-api-specs/blob/ecaa611ddf6742eb68f82ab5ecec6e64620a43cb/specification/communication/data-plane/Turn/preview/2021-02-22-preview1/CommunicationTurn.json"
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 11, 2021

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

    @openapi-workflow-bot
    Copy link

    Hi @JoshuaLai, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @JoshuaLai JoshuaLai marked this pull request as draft May 11, 2021 22:50
    @JoshuaLai
    Copy link
    Member Author

    The avocado errors are known errors I have run into before in a previous PR. Spoke to @ruowan about it in a previous PR #14312. So adding that approved avocado label.

    @JoshuaLai JoshuaLai marked this pull request as ready for review May 18, 2021 23:24
    @tjprescott
    Copy link
    Member

    @lmazuel can we force merge this?

    @lmazuel lmazuel merged commit dce2511 into Azure:master May 19, 2021
    @eladperets
    Copy link
    Contributor

    @JoshuaLai FYI I have a tool that parses swagger specs and I think it ran into an issue with your change. There's a reference from the eventgrid swagger that can no longer be resolved:

    https://github.com/Azure/azure-rest-api-specs/blob/master/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L116

    @JoshuaLai
    Copy link
    Member Author

    @eladperets I was unaware eventgrid swagger was referencing these. Yes the file path will need to be updated here to reflect the new name changes. I can create a new PR to get this resolved

    @JoshuaLai JoshuaLai deleted the issues/communicationrename branch May 19, 2021 22:25
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    …er services (Azure#14366)
    
    * [Communication] rename folders to be more consistent with cognitive services
    
    * [cSpell] fixing the cSpell for Chat path
    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.

    4 participants