Tsp next 045 #24265
Closed
Tsp next 045 #24265
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
- Prevents unintended "git diff"
|
Hi, @markcowl 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| openapi.json | v1.1(5fa7a1d) | v1.1(main) |
| contentsafety.json | 2023-04-30-preview(5fa7a1d) | 2023-04-30-preview(main) |
| openapi.json | 2023-03-01-preview(5fa7a1d) | 2023-03-01-preview(main) |
| fleets.json | 2022-09-02-preview(5fa7a1d) | 2022-09-02-preview(main) |
| fleets.json | 2023-03-15-preview(5fa7a1d) | 2023-03-15-preview(main) |
| widgets.json | 2022-11-01-preview(5fa7a1d) | 2022-11-01-preview(main) |
| openapi.json | v3.0(5fa7a1d) | v3.0(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.2) | new version | base version |
|---|---|---|
| release_1_1 | release_1_1(5fa7a1d) | release_1_1(typespec-next) |
| package-2023-04-30-preview | package-2023-04-30-preview(5fa7a1d) | package-2023-04-30-preview(typespec-next) |
| 2023-03-01-preview | 2023-03-01-preview(5fa7a1d) | 2023-03-01-preview(typespec-next) |
| package-2023-03-preview | package-2023-03-preview(5fa7a1d) | package-2023-03-preview(typespec-next) |
| package-2022-09-preview | package-2022-09-preview(5fa7a1d) | package-2022-09-preview(typespec-next) |
| package-2022-11-01-preview | package-2022-11-01-preview(5fa7a1d) | package-2022-11-01-preview(typespec-next) |
| release_3_0 | release_3_0(5fa7a1d) | release_3_0(typespec-next) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Schema should have a description or title. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1383 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: AnomalyDetector/stable/v1.1/openapi.json#L73 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: AnomalyDetector/stable/v1.1/openapi.json#L115 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: AnomalyDetector/stable/v1.1/openapi.json#L162 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: AnomalyDetector/stable/v1.1/openapi.json#L205 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: AnomalyDetector/stable/v1.1/openapi.json#L241 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true.Location: AnomalyDetector/stable/v1.1/openapi.json#L281 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: AnomalyDetector/stable/v1.1/openapi.json#L282 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: AnomalyDetector/stable/v1.1/openapi.json#L342 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Univariate' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: AnomalyDetector/stable/v1.1/openapi.json#L392 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Univariate' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: AnomalyDetector/stable/v1.1/openapi.json#L435 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Univariate' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: AnomalyDetector/stable/v1.1/openapi.json#L478 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L97 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L108 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L159 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L203 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L265 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L413 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L442 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L493 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true.Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L59 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L105 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true.Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L190 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L236 |
|
Property 'jobId' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1557 |
|
Property 'createdDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1557 |
|
Property 'expirationDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1557 |
|
Property 'lastUpdateDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1557 |
|
Property 'status' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1557 |
|
Property 'jobId' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1913 |
|
Property 'createdDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1913 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️❌TypeSpecAPIView: 0 Errors, 9 Warnings failed [Detail]
| Rule | Message |
|---|---|
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." | |
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." | |
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." | |
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." | |
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." | |
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." | |
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." | |
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." | |
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." |
️❌ModelValidation: 6 Errors, 0 Warnings failed [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️❌TypeSpec Validation: 10 Errors, 6 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
'Azure.Contoso.WidgetManager.StandardOperations' is referencing versioned type 'Azure.Core.ResourceOperations<Azure.Contoso.WidgetManager.(anonymous model), Azure.Core.Foundations.ErrorResponse>' but is not versioned itself. Location: specification/contosowidgetmanager/Contoso.WidgetManager/main.tsp#L41 |
|
"details":"The generated swagger file v1.1/openapi.json from typespec specification/cognitiveservices/AnomalyDetector is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
|
"details":"The generated swagger file 2023-04-30-preview/contentsafety.json from typespec specification/cognitiveservices/ContentSafety is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
|
"details":"The 'examples' directory is missing in the typespec folder specification/cognitiveservices/OpenAI.Inference, please ensure the 'examples' is added in the PR." |
|
"details":"The generated swagger file 2022-12-01/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not on the branch." |
|
"details":"The generated swagger file 2023-03-15-preview/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not on the branch." |
|
"details":"The generated swagger file 2022-09-02-preview/fleets.json from typespec specification/containerservice/Fleet.Management is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2022-09-02-preview/fleets.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
|
"details":"The generated swagger file 2023-03-15-preview/fleets.json from typespec specification/containerservice/Fleet.Management is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
|
"details":"The generated swagger file 2023-05-01-preview/TrafficController.json from typespec specification/servicenetworking/ServiceNetworking.Management is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
|
"details":"The generated swagger file v3.0/openapi.json from typespec specification/translation/Azure.AI.TextTranslation is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/openapi.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
| Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/completions.create.tsp#L198 |
|
| Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/chat.completions.tsp#L162 |
|
| Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/completions.create.tsp#L198 |
|
| Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/chat.completions.tsp#L162 |
|
| "details":"The configuration 'output-file' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/OpenAI.Inference, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
|
| "details":"The configuration 'azure-resource-provider-folder' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/OpenAI.Inference, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
ghost
added
|
/azp run specs - typespec - ci |
|
Azure Pipelines could not run because the pipeline triggers exclude this branch/path. |
mikeharder
force-pushed
the
typespec-next
branch
5 times, most recently
from
8fee851
to
1d4608c
Compare
mikeharder
reviewed
Jun 6, 2023
| @@ -78,7 +78,8 @@ | |||
| "in": "body", | |||
| "schema": { | |||
| "$ref": "#/definitions/OncoPhenotypeData" | |||
| } | |||
| }, | |||
| "required": true | |||
There was a problem hiding this comment.
@markcowl: What is causing the addition of "required" here? Is this a breaking change?
mikeharder
force-pushed
the
typespec-next
branch
3 times, most recently
from
d09b8d9
to
c977b36
Compare
mikeharder
force-pushed
the
typespec-next
branch
2 times, most recently
from
a2bcc71
to
a576f5a
Compare
|
Hi, @markcowl. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
mikeharder
force-pushed
the
typespec-next
branch
from
f285c01
to
bc46fa4
Compare
|
Hi, @markcowl. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
|
Hi, @markcowl. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
mikeharder
force-pushed
the
typespec-next
branch
from
5389609
to
9d5a96e
Compare
|
Hi, @markcowl. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
4 similar comments
|
Hi, @markcowl. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @markcowl. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @markcowl. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
|
Hi, @markcowl. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
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.
Splitting into smaller PRs that can be merged against 0.44.0: