Skip to content
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
merged 2 commits into from
Aug 21, 2023

Conversation

mikeharder
Copy link
Member

@mikeharder mikeharder commented Aug 19, 2023

Reacts to Azure/typespec-azure#3400

@timotheeguerin, @markcowl, @tjprescott: Was Azure/typespec-azure#3400 expected to cause these diffs in generated autorest?

@mikeharder mikeharder requested review from vicancy and mikekistler and removed request for a team August 19, 2023 03:04
@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 19, 2023

Next Steps to Merge

⚠️ This is an experimental comment. It may not always be up-to-date. ⚠️

Next steps that must be taken to merge this PR:
  • ❌ Your PR has breaking changes (label: BreakingChangeReviewRequired). See the PR description for help.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 19, 2023

Swagger Validation Report

️❌BreakingChange: 6 Errors, 0 Warnings failed [Detail]
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)
Rule Message
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'TextBlocklistUpdate' removed or renamed?
New: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L548:3
Old: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L548:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'FakedSharedModelUpdate' removed or renamed?
New: Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json#L340:3
Old: Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json#L340:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'WidgetSuiteUpdate' removed or renamed?
New: Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json#L340:3
Old: Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json#L340:3
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L205:13
Old: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L205:13
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json#L145:13
Old: Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json#L145:13
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json#L543:9
Old: Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json#L543:9
️️✔️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
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L41
⚠️ PatchInOperationName '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
⚠️ ListInOperationName 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
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L285
⚠️ ParameterDescription Parameter should have a description.
Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L302
⚠️ ParameterDescription Parameter should have a description.
Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L356
⚠️ PathParameterSchema Path parameter should specify characters allowed (pattern).
Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L465
⚠️ EnumInsteadOfBoolean 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
⚠️ SchemaNamesConvention Schema name should be Pascal case.
Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L684
⚠️ SchemaNamesConvention Schema name should be Pascal case.
Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L718
⚠️ SchemaNamesConvention Schema name should be Pascal case.
Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L731
⚠️ SchemaDescriptionOrTitle 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]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 19, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from f9ec5c0081dccae8458e0f6d8791cc6590bdf546. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    warn		specification/contosowidgetmanager/data-plane/readme.md skipped due to azure-sdk-for-python-track2 not found in swagger-to-sdk
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]
    cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.6.7 -> 9.8.1
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.8.1` to update!
    cmderr	[automation_generate.sh] npm notice
    warn	No file changes detected after generation
    warn	No package detected after generation
️⚠️ azure-sdk-for-net-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from f9ec5c0081dccae8458e0f6d8791cc6590bdf546. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    warn		specification/contosowidgetmanager/data-plane/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    warn	No file changes detected after generation
    warn	Skip detect changed packages
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from f9ec5c0081dccae8458e0f6d8791cc6590bdf546. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    warn	No file changes detected after generation
    warn	No package detected after generation
️⚠️ azure-sdk-for-js warning [Detail]
  • ⚠️Warning [Logs] Generate from f9ec5c0081dccae8458e0f6d8791cc6590bdf546. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    warn	No file changes detected after generation
    warn	No package detected after generation
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs] Generate from f9ec5c0081dccae8458e0f6d8791cc6590bdf546. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    warn	No file changes detected after generation
    warn	Skip detect changed packages
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs] Generate from f9ec5c0081dccae8458e0f6d8791cc6590bdf546. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    warn		specification/contosowidgetmanager/data-plane/readme.md skipped due to azure-powershell not found in swagger-to-sdk
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ⚠️Az.cognitiveservices.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.cognitiveservices.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 19, 2023

Generated ApiView

Language Package Name ApiView Link
Swagger cognitiveservices-data-plane-ContentSafety https://apiview.dev/Assemblies/Review/badf7aa8f0bc4934bf2c18a3c4ea8a20
Swagger contosowidgetmanager-data-plane-Azure.Contoso.WidgetManager https://apiview.dev/Assemblies/Review/08a0b5e1015f44d3897c217c7e845178

@AzureRestAPISpecReview 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 mikeharder merged commit d253d1e into Azure:typespec-next Aug 21, 2023
@mikeharder mikeharder deleted the typespec-next-3400 branch August 21, 2023 18:31
@mikeharder mikeharder self-assigned this Aug 21, 2023
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
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants