Update swagger to reconcile SDK generation mismatch #24670
Closed
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
stewartadam and
weidongxu-microsoft
and removed request for
a team
|
Hi, @ericasp16! Thank you for your pull request. To help get your PR merged: |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/ce93b56111bd5a3858557b59ee7b630c62c19078/specification/communication/data-plane/PhoneNumbers/stable/2022-12-01/phonenumbers.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/communication/data-plane/PhoneNumbers/stable/2022-12-01/phonenumbers.json", "details":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.54/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=specification/communication/data-plane/PhoneNumbers/stable/2022-12-01/phonenumbers.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Syntax Error Encountered: Unexpected token in JSON\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/PhoneNumbers/stable/2022-12-01/phonenumbers.json:1305:6\n" |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️❌LintDiff: 2 Errors, 0 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-phonenumber-2022-12-01 | package-phonenumber-2022-12-01(ce93b56) | package-phonenumber-2022-12-01(ericasp/number-lookup-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L1392 |
|
|
The host parameter must be typed 'type 'string', format 'url''. Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L1424 |
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/2022-12-01/phonenumbers.json#L20 |
|
Response body schema of pageable response should contain top-level array property valueLocation: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L97 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L101 |
|
Response body schema of pageable response should contain top-level array property valueLocation: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L159 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L163 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L192 |
|
Response body schema of pageable response should contain top-level array property valueLocation: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L234 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L238 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L267 |
|
Response body schema of pageable response should contain top-level array property valueLocation: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L331 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L335 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L367 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L412 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L441 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L459 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L515 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L544 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2022-12-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/2022-12-01/phonenumbers.json#L586 |
|
| OperationId for delete method should contain 'Delete' Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L586 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L588 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L603 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L634 |
|
| The body parameter is not marked as required. Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L644 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L678 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L707 |
|
| Error response should contain a x-ms-error-code header. Location: PhoneNumbers/stable/2022-12-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/2022-12-01/phonenumbers.json#L743 |
|
| OperationId for delete method should contain 'Delete' Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L743 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L745 |
️❌Avocado: 4 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The file is not a valid JSON file. json: [PhoneNumbers/stable/2022-12-01/phonenumbers.json"}]({"kind":"structure","code":"unexpected token","position":{"line":1305,"column":7},"token":"}","message":"unexpected token, token: }, line: 1305, column: 7","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/communication/data-plane/PhoneNumbers/stable/2022-12-01/phonenumbers.json"}) |
|
The file is not a valid JSON file. json: [PhoneNumbers/stable/2022-12-01/phonenumbers.json"}]({"kind":"structure","code":"unexpected token","position":{"line":1306,"column":5},"token":"}","message":"unexpected token, token: }, line: 1306, column: 5","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/communication/data-plane/PhoneNumbers/stable/2022-12-01/phonenumbers.json"}) |
|
The file is not a valid JSON file. json: [PhoneNumbers/stable/2022-12-01/phonenumbers.json"}]({"kind":"structure","code":"unexpected token","position":{"line":1306,"column":6},"token":",","message":"unexpected token, token: ,, line: 1306, column: 6","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/communication/data-plane/PhoneNumbers/stable/2022-12-01/phonenumbers.json"}) |
|
The file is not a valid JSON file. json: [PhoneNumbers/stable/2022-12-01/phonenumbers.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":849,"column":18},"token":"}","message":"unexpected end of file, token: }, line: 849, column: 18","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/communication/data-plane/PhoneNumbers/stable/2022-12-01/phonenumbers.json"}) |
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Json parsing error: unexpected token Url: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L1305:7 |
️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Json parsing error: unexpected token JsonUrl: PhoneNumbers/stable/2022-12-01/phonenumbers.json#L1305:7 |
️❌PrettierCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Code style issues found path: PhoneNumbers/stable/2022-12-01/phonenumbers.json |
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️❌CadlValidation: 0 Errors, 0 Warnings failed [Detail]
️❌TypeSpec Validation: 0 Errors, 0 Warnings failed [Detail]
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
|
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
|
Hi @ericasp16! Your PR has some issues. Please fix the CI issues, if present, in following order:
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel. |
|
Hi @ericasp16! The automation detected this pull request introduces changes to at least one existing API version that violate Azure's versioning policy. To comply with the policy, these changes must be made in a new API version. As a result, the automation added the |
|
abandoning this review in favor of a new one: #24672 |
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
The PhoneNumbers SDKs were generated on a swagger that is slightly different to the one that is checked into this repository. This is causing an issue when trying to make incremental changes for new features. This change aims to bring them into alignment and reach parity to unblock further SDK development
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.
Communication/PhoneNumbers - Add Number Lookup API #23053
[Communication - Phone Number Service] Proposed countries offerings API for the ACS Phone Number Service. #18869
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.
❔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