-
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-next] React to Azure/typespec-azure#3400 #25400
Merged
mikeharder
merged 2 commits into
Azure:typespec-next
from
mikeharder:typespec-next-3400
Aug 21, 2023
Merged
[typespec-next] React to Azure/typespec-azure#3400 #25400
mikeharder
merged 2 commits into
Azure:typespec-next
from
mikeharder:typespec-next-3400
Aug 21, 2023
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
mikeharder
requested review from
weshaggard,
konrad-jamrozik,
yangyuan and
a team
as code owners
August 19, 2023 03:04
mikeharder
requested review from
vicancy and
mikekistler
and removed request for
a team
August 19, 2023 03:04
Next Steps to Merge
|
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
contentsafety.json | 2023-04-30-preview(ba2c6bb) | 2023-04-30-preview(main) |
widgets.json | 2022-11-01-preview(ba2c6bb) | 2022-11-01-preview(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) | new version | base version |
---|---|---|
package-2023-04-30-preview | package-2023-04-30-preview(ba2c6bb) | package-2023-04-30-preview(typespec-next) |
package-2022-11-01-preview | package-2022-11-01-preview(ba2c6bb) | package-2022-11-01-preview(typespec-next) |
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 |
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#L137 |
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#L181 |
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#L243 |
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#L391 |
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#L449 |
Security definition should have a description. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L41 |
|
'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#L181 |
|
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#L285 |
|
Operation might be pageable. Consider adding the x-ms-pageable extension. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L285 |
|
Parameter should have a description. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L302 |
|
Parameter should have a description. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L356 |
|
Path parameter should specify characters allowed (pattern). Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L465 |
|
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#L645 |
|
Schema name should be Pascal case. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L684 |
|
Schema name should be Pascal case. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L718 |
|
Schema name should be Pascal case. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L731 |
|
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.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
<valid label in PR review process>add this label when breaking change review is required
data-plane
labels
Aug 19, 2023
mikeharder
commented
Aug 19, 2023
...widgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json
Show resolved
Hide resolved
mikeharder
commented
Aug 19, 2023
...ion/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
BreakingChangeReviewRequired
<valid label in PR review process>add this label when breaking change review is required
data-plane
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.
Reacts to Azure/typespec-azure#3400
@timotheeguerin, @markcowl, @tjprescott: Was Azure/typespec-azure#3400 expected to cause these diffs in generated autorest?