[TypeSpec] Upgrade to 0.51.0 #26956
Merged
[TypeSpec] Upgrade to 0.51.0 #26956
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
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 |
|---|---|---|
| communicationservicejobrouter.json | 2023-11-01(72ca6ca) | 2023-11-01(main) |
| Rule | Message |
|---|---|
|
The new version has a different format than the previous one. New: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L2308:9 Old: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L2309:9 |
|
The new version has a different format than the previous one. New: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L2610:9 Old: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L2611:9 |
|
The new version has a different format than the previous one. New: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L2710:9 Old: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L2711:9 |
|
The new version has a different format than the previous one. New: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L3486:9 Old: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L3487:9 |
|
The new version has a different format than the previous one. New: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L3863:9 Old: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L3864:9 |
|
The new version has a different format than the previous one. New: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L4046:9 Old: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L4047:9 |
|
The new version has a different format than the previous one. New: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L2222:5 Old: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L2222:5 |
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/72ca6ca21c98d3338cad5ff205f9eb7cf0f9e3f4/specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 6 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Second line should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.66/common/temp/node_modules/.pnpm/@Azure+oad@0.10.4/node_modules/autorest/dist/app.js" --v2 --input-file=specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp -------------------- 2: ERROR: Schema violation: Data does not match any schemas from 'oneOf' -------------------- 3: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json:221:10 ($.paths["/trialmatcher/jobs"].post.responses["202"]) -------------------- 4: ERROR: Schema violation: Data does not match any schemas from 'oneOf' -------------------- 5: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json:92:10 ($.paths["/oncophenotype/jobs"].post.responses["202"]) -------------------- 6: FATAL: swagger-document/individual/schema-validator - FAILED --------------------" |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| 2023-03-01-preview | 2023-03-01-preview(72ca6ca) | 2023-03-01-preview(main) |
| package-jobrouter-2023-11-01 | package-jobrouter-2023-11-01(72ca6ca) | package-jobrouter-2023-11-01(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Security definition should have a description. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L43 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L58 |
|
| header parameter name 'Repeatability-Request-ID' should be kebab case. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L70 |
|
| Parameter should have a description. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L76 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L151 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L187 |
|
| header parameter name 'Repeatability-Request-ID' should be kebab case. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L199 |
|
| Parameter should have a description. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L205 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L280 |
|
| Schema should have a description or title. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L378 |
|
| Schema name should be Pascal case. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L437 |
|
| Schema name should be Pascal case. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L471 |
|
| Schema name should be Pascal case. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L484 |
|
| Schema name should be Pascal case. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L498 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1489 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1494 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1506 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1839 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1844 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L38 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L86 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L94 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L139 |
|
| OperationId for patch method should contain both 'Create' and 'Update' Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L140 |
|
| 'PATCH' operation 'JobRouterAdministrationOperations_UpsertClassificationPolicy' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L140 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L150 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L230 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L238 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L271 |
|
| The summary and description values should not be same. Location: JobRouter/stable/2023-11-01/communicationservicejobrouter.json#L319 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Following response status codes 200 for operation OncoPhenotype_CreateJob were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: HealthInsights/preview/2023-03-01-preview/openapi.json#L86:18 ExampleUrl: preview/2023-03-01-preview/examples/SuccessfulOncoPhenotypeRequest.json#L52:16 |
|
Following response status codes 200 for operation TrialMatcher_CreateJob were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: HealthInsights/preview/2023-03-01-preview/openapi.json#L215:18 ExampleUrl: preview/2023-03-01-preview/examples/SuccessfulTrialMatcherRequest.json#L149:16 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
mikeharder
requested review from
weshaggard,
konrad-jamrozik,
yangyuan and
a team
as code owners
mikeharder
requested review from
johanste and
MushMal
and removed request for
a team
konrad-jamrozik
approved these changes
Dec 7, 2023
mikeharder
added
Approved-BreakingChange
arifibrahim4
pushed a commit
that referenced
this pull request
Feb 26, 2024
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.
1023 - TypeFormatChangedcaused by removal offormat: eTagData does not match any schemas from 'oneOf'x-ms-enumneedsnameproperty. TypeSpec will hotfix.