-
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-Clean]: Content-safety changes #23965
Merged
Merged
+17
−14
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
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(4d503fe) | 2023-04-30-preview(main) |
️️✔️
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.1) | new version | base version |
---|---|---|
package-2023-04-30-preview | package-2023-04-30-preview(4d503fe) | 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: 18 Errors, 5 Warnings failed [Detail]
Rule | Message |
---|---|
unknown-identifier |
Unknown identifier Cadl Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L9 |
unknown-identifier |
Unknown identifier Cadl Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L10 |
unknown-identifier |
Unknown identifier Cadl Location: specification/cognitiveservices/OpenAI.Authoring/finetune.tsp#L93 |
unknown-decorator |
Unknown decorator Location: specification/cognitiveservices/OpenAI.Authoring/finetune.tsp#L93 |
unknown-identifier |
Unknown identifier route Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L27 |
unknown-decorator |
Unknown decorator Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L27 |
unknown-identifier |
Unknown identifier get Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L28 |
unknown-decorator |
Unknown decorator Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L28 |
import-not-found |
Couldn't resolve import "@azure-tools/typespec-client-generator-core" Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L4 |
invalid-ref |
Namespace Azure doesn't have member ClientGenerator Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L13 |
unknown-identifier |
Unknown identifier convenientAPI Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L20 |
unknown-decorator |
Unknown decorator Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L20 |
unknown-identifier |
Unknown identifier convenientAPI Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L31 |
unknown-decorator |
Unknown decorator Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L31 |
unknown-identifier |
Unknown identifier convenientAPI Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L42 |
unknown-decorator |
Unknown decorator Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L42 |
MissingExamplesDirectory |
"details":"The 'examples' directory is missing in the typespec folder specification/cognitiveservices/OpenAI.Authoring, please ensure the 'examples' is added in the PR." |
MissingExamplesDirectory |
"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 configuration 'azure-resource-provider-folder' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/AnomalyDetector, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
|
"details":"The configuration 'output-file' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/OpenAI.Authoring, 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.Authoring, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
|
"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.
ghost
added
the
Cognitive Services
label
May 12, 2023
Swagger Generation Artifacts
|
Generated ApiView
|
mikeharder
requested changes
May 12, 2023
mikeharder
approved these changes
May 12, 2023
3 tasks
This was referenced May 13, 2023
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.
cognitiveservices
). Validation ofContentSafety
folder passed.