Number lookup ga alternative expand parameter #26602
Closed
Conversation
This file contains hidden or 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
johanste and
mikekistler
and removed request for
a team
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| phonenumbers.json | 2024-03-01(f06c540) | 2022-12-01(main) |
| phonenumbers.json | 2024-03-01(f06c540) | 2023-05-01-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-phonenumber-2024-03-01 | package-phonenumber-2024-03-01(f06c540) | 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/stable/2024-03-01/phonenumbers.json#L849 |
||
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L891 |
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/stable/2024-03-01/phonenumbers.json#L20 |
|
Response body schema of pageable response should contain top-level array property valueLocation: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L97 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L101 |
|
Response body schema of pageable response should contain top-level array property valueLocation: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L159 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L163 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L192 |
|
Response body schema of pageable response should contain top-level array property valueLocation: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L234 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L238 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L267 |
|
Response body schema of pageable response should contain top-level array property valueLocation: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L331 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L335 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L367 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L412 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L441 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L459 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L515 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L544 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2024-03-01/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/stable/2024-03-01/phonenumbers.json#L586 |
|
| OperationId for delete method should contain 'Delete' Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L586 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L588 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L603 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L634 |
|
| The body parameter is not marked as required. Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L644 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L678 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L707 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2024-03-01/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/stable/2024-03-01/phonenumbers.json#L743 |
|
| OperationId for delete method should contain 'Delete' Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L743 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2024-03-01/phonenumbers.json#L745 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView 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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Nov 7, 2023
microsoft-github-policy-service
bot
added
no-recent-activity
and removed
no-recent-activity
labels
Member
Author
|
We've settled on an alternate design |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Updates prior to the GA of Number Lookup feature. Customers can search any phone number to receive formatting and operator information details about the searched number.
This is one alternative design being considered. The feature team's preferred design can be found here: #26294, and the other alternative can be found here: #26601
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec 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 API Spec document (if applicable), and the root paths that have been updated.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔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