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

New SIP routing API version preview/2021-05-01-preview #14500

Conversation

jannovak-msft
Copy link
Contributor

@jannovak-msft jannovak-msft commented May 20, 2021

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, @jannovak-msft 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-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 20, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️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.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"communication/data-plane/SipRouting/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"communication/data-plane/SipRouting/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"communication/data-plane/SipRouting/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.15.456)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"communication/data-plane/SipRouting/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 20, 2021

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

    @jannovak-msft jannovak-msft force-pushed the dev-communication-Microsoft.CommunicationServicesSipRouting-2021-05-01-preview branch from 88a50f8 to 915f2c4 Compare May 20, 2021 13:35
    @jannovak-msft jannovak-msft force-pushed the dev-communication-Microsoft.CommunicationServicesSipRouting-2021-05-01-preview branch from b9b8039 to e440de8 Compare May 26, 2021 16:19
    @jannovak-msft jannovak-msft force-pushed the dev-communication-Microsoft.CommunicationServicesSipRouting-2021-05-01-preview branch from f36001c to 9d503fa Compare June 1, 2021 11:51
    @jannovak-msft jannovak-msft marked this pull request as ready for review June 1, 2021 14:26
    @markweitzel markweitzel added the APIStewardshipBoard-ReviewRequested This should be reviewed by the Azure API Stewardship team in partnership with the service team. label Jun 2, 2021
    @jannovak-msft jannovak-msft force-pushed the dev-communication-Microsoft.CommunicationServicesSipRouting-2021-05-01-preview branch from 63c948f to a045db3 Compare June 8, 2021 13:08
    @jannovak-msft jannovak-msft force-pushed the dev-communication-Microsoft.CommunicationServicesSipRouting-2021-05-01-preview branch from 61f87ae to 0156341 Compare June 14, 2021 15:58
    @anuchandy anuchandy merged commit 3b84377 into master Jun 14, 2021
    asager pushed a commit to asager/azure-rest-api-specs that referenced this pull request Jun 24, 2021
    * sip routing API
    
    * return 422 instead of 400
    
    * change missing trunk error message
    
    * add 'error' prefix in error examples
    
    * describe patch behaviour
    
    * use the standard Azure error
    
    * remove unnecessary descriptions
    
    * fix descriptions
    
    * change fqdn max length
    
    * remove locale from example params and change endpoint
    
    * use the standard Azure error in examples
    
    * unify tags
    
    * use CommunicationServicesCommon/CommunicationErrorResponse
    
    * refactor sip configuration patch into separate class
    
    * fix CommunicationErrorResponse file path
    
    * add x-ms-error-response flag
    
    * add http errors schemas
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * sip routing API
    
    * return 422 instead of 400
    
    * change missing trunk error message
    
    * add 'error' prefix in error examples
    
    * describe patch behaviour
    
    * use the standard Azure error
    
    * remove unnecessary descriptions
    
    * fix descriptions
    
    * change fqdn max length
    
    * remove locale from example params and change endpoint
    
    * use the standard Azure error in examples
    
    * unify tags
    
    * use CommunicationServicesCommon/CommunicationErrorResponse
    
    * refactor sip configuration patch into separate class
    
    * fix CommunicationErrorResponse file path
    
    * add x-ms-error-response flag
    
    * add http errors schemas
    @JackTn JackTn deleted the dev-communication-Microsoft.CommunicationServicesSipRouting-2021-05-01-preview branch June 16, 2022 00:48
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    APIStewardshipBoard-ReviewRequested This should be reviewed by the Azure API Stewardship team in partnership with the service team.
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants