Communication/PhoneNumbers - Add Number Lookup API #23053
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ericasp16
requested review from
bexxx and
MushMal
and removed request for
a team
|
Hi, @ericasp16 Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| phonenumbers.json | 2023-05-01-preview(dfbfd12) | 2022-12-01(main) |
| phonenumbers.json | 2023-05-01-preview(dfbfd12) | 2022-06-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-phonenumber-2023-05-01-preview | package-phonenumber-2023-05-01-preview(dfbfd12) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L849 |
||
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L882 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L20 |
|
Response body schema of pageable response should contain top-level array property valueLocation: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L97 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L101 |
|
Response body schema of pageable response should contain top-level array property valueLocation: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L159 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L163 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L192 |
|
Response body schema of pageable response should contain top-level array property valueLocation: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L234 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L238 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L267 |
|
Response body schema of pageable response should contain top-level array property valueLocation: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L331 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L335 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L367 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L412 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L441 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L459 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L515 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L544 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L568 |
|
| 'DELETE' operation 'PhoneNumbers_CancelOperation' should use method name 'Delete'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L586 |
|
| OperationId for delete method should contain 'Delete' Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L586 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L588 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L603 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L634 |
|
| The body parameter is not marked as required. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L644 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L678 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L707 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L725 |
|
| 'DELETE' operation 'PhoneNumbers_ReleasePhoneNumber' should use method name 'Delete'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L743 |
|
| OperationId for delete method should contain 'Delete' Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L743 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json#L745 |
️️✔️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]
️️✔️TypeSpecAPIView 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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
Generated ApiView
|
|
Hi @ericasp16, Your PR has some issues. Please fix the CI sequentially by following the order of
|
mikekistler
added
the
APIStewardshipBoard-SignedOff
mikekistler
approved these changes
Apr 11, 2023
…e latest preview version, not the stable version
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @ericasp16, 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. |
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
|
@mikekistler I've rebased my swagger onto the latest version, and I've fixed up the PR based on the review feedback. Can you take another look and make sure we're looking good to get this merged? Let me know if you see anything that needs follow-up. Thank you! |
|
This PR is good to go from the API Stewardship POV. @ericasp16 is this ready to merge? |
|
Yes, we're ready to merge. @jhendrixMSFT as the assignee are you able to help us get this merged? Thanks! |
jhendrixMSFT
deleted the
ericasp/communication-phone-numbers-number-lookup
branch
This was referenced Jun 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
Add a new preview version to the Phone Numbers package and add an API for looking up phone numbers. This is a feature which will allow customers to look up recipient phone numbers before communicating with them (e.g. sending SMS).
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your engagement record.
Is this review for (select one):
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.
❔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.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
fix #23060