-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[TypeSpec Update]: Update Versions and ContentSafety #23974
Conversation
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 |
---|---|---|
contentsafety.json | 2023-04-30-preview(677876b) | 2023-04-30-preview(main) |
Rule | Message |
---|---|
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L414:9 Old: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L414:9 |
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L1055:5 Old: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L1055:5 |
️️✔️
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.2) | new version | base version |
---|---|---|
package-2023-04-30-preview | package-2023-04-30-preview(677876b) | package-2023-04-30-preview(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
OperationIdNounVerb |
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 |
AvoidAnonymousTypes |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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#L411 |
AvoidAnonymousTypes |
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#L440 |
OperationIdNounVerb |
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#L491 |
Security definition should have a description. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L41 |
|
Schema with type: string has unrecognized format: uri Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L63 |
|
Schema with type: string has unrecognized format: uri Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L122 |
|
'PATCH' operation 'TextBlocklists_CreateOrUpdateTextBlocklist' 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: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L203 |
|
Since operation response has model definition in array type, it should be of the form '_list'. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L307 |
|
Operation might be pageable. Consider adding the x-ms-pageable extension. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L307 |
|
Parameter should have a description. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L324 |
|
The body parameter is not marked as required. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L324 |
|
Parameter should have a description. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L377 |
|
The body parameter is not marked as required. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L377 |
|
Schema with type: string has unrecognized format: uri Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L454 |
|
Path parameter should specify characters allowed (pattern). Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L507 |
|
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: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L691 |
|
Schema name should be Pascal case. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L732 |
|
Schema name should be Pascal case. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L768 |
|
Schema name should be Pascal case. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L781 |
|
Schema should have a description or title. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L1018 |
️️✔️
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: 4 Errors, 12 Warnings failed [Detail]
Rule | Message |
---|---|
InConsistentSwagger |
"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." |
MissingExamplesDirectory |
"details":"The 'examples' directory is missing in the typespec folder specification/cognitiveservices/OpenAI.Inference, please ensure the 'examples' is added in the PR." |
SwaggerNotExistInPRBranch |
"details":"The generated swagger file 2022-12-01/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not on the branch." |
SwaggerNotExistInPRBranch |
"details":"The generated swagger file 2023-03-15-preview/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not on the branch." |
The names of Operation types must use camelCase Location: cognitiveservices/AnomalyDetector/univariate/routes.tsp#L18 |
|
The names of Operation types must use camelCase Location: cognitiveservices/AnomalyDetector/univariate/routes.tsp#L37 |
|
The names of Operation types must use camelCase Location: cognitiveservices/AnomalyDetector/univariate/routes.tsp#L54 |
|
The names of Operation types must use camelCase Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L22 |
|
The names of Operation types must use camelCase Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L40 |
|
The names of Operation types must use camelCase Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L70 |
|
The names of Operation types must use camelCase Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L86 |
|
The names of Operation types must use camelCase Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L105 |
|
The names of Operation types must use camelCase Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L122 |
|
The names of Operation types must use camelCase Location: cognitiveservices/AnomalyDetector/multivariate/routes.tsp#L153 |
|
"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
|
Generated ApiView
|
Hi @markcowl, 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved, but please wait to merge all version update PRs in quick succession.
Data Plane API - Pull Request
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.
❔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