azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Number pattern routing validation

Open kdruzycki opened this issue 3 years ago • 5 comments

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • [ ] new service onboarding
    • [x] 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)
    • [x] 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: :warning:

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.

kdruzycki avatar Aug 18 '22 09:08 kdruzycki

Hi, @kdruzycki 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]

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 2 Warnings warning [Detail]
    compared swaggers (via Oad v0.9.7)] new version base version
    communicationservicessiprouting.json 2022-09-01-preview(797a832) 2021-05-01-preview(main)
    communicationservicessiprouting.json 2022-10-01-preview(797a832) 2021-05-01-preview(main)

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

    Rule Message
    :warning: 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: SipRouting/preview/2022-09-01-preview/communicationservicessiprouting.json#L336:11
    Old: SipRouting/preview/2021-05-01-preview/communicationservicessiprouting.json#L184:11
    :warning: 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: SipRouting/preview/2022-10-01-preview/communicationservicessiprouting.json#L389:11
    Old: SipRouting/preview/2021-05-01-preview/communicationservicessiprouting.json#L184:11
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-09-01-preview package-2022-09-01-preview(797a832) default(main)
    package-2022-10-01-preview package-2022-10-01-preview(797a832) default(main)
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️❌ModelValidation: 4 Errors, 0 Warnings failed [Detail]
    Rule Message
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: numberPattern
    Url: SipRouting/preview/2022-10-01-preview/communicationservicessiprouting.json#L348:19
    ExampleUrl: preview/2022-10-01-preview/examples/CheckRoutingForNumber.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: numberPattern
    Url: SipRouting/preview/2022-10-01-preview/communicationservicessiprouting.json#L348:19
    ExampleUrl: preview/2022-10-01-preview/examples/CheckRoutingForNumber.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: numberPattern
    Url: SipRouting/preview/2022-10-01-preview/communicationservicessiprouting.json#L348:19
    ExampleUrl: preview/2022-10-01-preview/examples/CheckRoutingForNumber.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: numberPattern
    Url: SipRouting/preview/2022-10-01-preview/communicationservicessiprouting.json#L348:19
    ExampleUrl: preview/2022-10-01-preview/examples/CheckRoutingForNumber.json
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/797a832c92274ac4a981f829d368bae951459d91/specification/communication/data-plane/SipRouting/readme.md#tag-package-2022-09-01-preview">communication/data-plane/SipRouting/readme.md#package-2022-09-01-preview
      • "https://github.com/Azure/azure-rest-api-specs/blob/797a832c92274ac4a981f829d368bae951459d91/specification/communication/data-plane/SipRouting/readme.md#tag-package-2022-10-01-preview">communication/data-plane/SipRouting/readme.md#package-2022-10-01-preview
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    Posted by Swagger Pipeline | How to fix these errors?

    Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

    Hi @kdruzycki, 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.