Skip to content

Gallery 03 03 Api Version#19644

Merged
ArcturusZhang merged 10 commits intoAzure:feature/gallery-2022-03-03-2ndfrom
tiregan:gallery_03_03_2nd
Aug 2, 2022
Merged

Gallery 03 03 Api Version#19644
ArcturusZhang merged 10 commits intoAzure:feature/gallery-2022-03-03-2ndfrom
tiregan:gallery_03_03_2nd

Conversation

@tiregan
Copy link
Contributor

@tiregan tiregan commented Jun 30, 2022

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 30, 2022

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 3 Errors, 21 Warnings failed [Detail]
compared swaggers (via Oad v0.9.6)] new version base version
gallery.json 2022-03-03(16e9d74) 2021-10-01(main)
gallery.json 2022-03-03(16e9d74) 2020-09-30(main)
sharedGallery.json 2022-03-03(16e9d74) 2021-07-01(main)
sharedGallery.json 2022-03-03(16e9d74) 2020-09-30(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule Message
1019 - RemovedEnumValue The new version is removing enum value(s) 'Community' from the old version.
New: galleryRP/stable/2022-03-03/gallery.json#L1896:9
Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L1842:9
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'uri' renamed or removed?
New: galleryRP/stable/2022-03-03/gallery.json#L2800:7
Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L2741:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'uri' renamed or removed?
New: galleryRP/stable/2022-03-03/gallery.json#L2814:7
Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L2741:7
⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
New: galleryRP/stable/2022-03-03/gallery.json#L2779:9
Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L2721:9
⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
New: galleryRP/stable/2022-03-03/gallery.json#L2869:9
Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L2800:9
⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
New: galleryRP/stable/2022-03-03/gallery.json#L2869:9
Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L2800:9
⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
New: galleryRP/stable/2022-03-03/gallery.json#L2869:9
Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L2800:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: galleryRP/stable/2022-03-03/gallery.json#L2779:9
Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L2721:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: galleryRP/stable/2022-03-03/gallery.json#L2869:9
Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L2800:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: galleryRP/stable/2022-03-03/gallery.json#L2869:9
Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L2800:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: galleryRP/stable/2022-03-03/gallery.json#L2869:9
Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L2800:9


The following breaking changes are detected by comparison with the latest preview version:

Rule Message
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'LocationNameParamter' removed or renamed?
New: azure-rest-api-specs/blob/16e9d7438427bd212997c1bc8744e33d36b60c0e/revision#L1034:2
Old: Microsoft.Compute/preview/2020-09-30/sharedGallery.json#L762:3
⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
New: galleryRP/stable/2022-03-03/gallery.json#L2664:9
Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2358:9
⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
New: galleryRP/stable/2022-03-03/gallery.json#L2779:9
Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2439:9
⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
New: galleryRP/stable/2022-03-03/gallery.json#L2869:9
Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2515:9
⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
New: galleryRP/stable/2022-03-03/gallery.json#L2869:9
Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2515:9
⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
New: galleryRP/stable/2022-03-03/gallery.json#L2680:5
Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2371:5
⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
New: galleryRP/stable/2022-03-03/gallery.json#L2869:9
Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2515:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: galleryRP/stable/2022-03-03/gallery.json#L2779:9
Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2439:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: galleryRP/stable/2022-03-03/gallery.json#L2869:9
Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2515:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: galleryRP/stable/2022-03-03/gallery.json#L2869:9
Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2515:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: galleryRP/stable/2022-03-03/gallery.json#L2869:9
Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2515:9
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'uri' renamed or removed?
New: galleryRP/stable/2022-03-03/gallery.json#L2800:7
Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2456:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'uri' renamed or removed?
New: galleryRP/stable/2022-03-03/gallery.json#L2814:7
Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2456:7
️⚠️LintDiff: 4 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) new version base version
package-2022-03-03 package-2022-03-03(16e9d74) package-2022-03-03(feature/gallery-2022-03-03-2nd)

The following errors/warnings are introduced by current PR:

Rule Message
⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: required
Location: galleryRP/stable/2022-03-03/gallery.json#L2239
⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: excludeFromLatest
Location: galleryRP/stable/2022-03-03/gallery.json#L2595
⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowDeletionOfReplicatedLocations
Location: galleryRP/stable/2022-03-03/gallery.json#L2897
⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: reportedForPolicyViolation
Location: galleryRP/stable/2022-03-03/gallery.json#L2907


The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule Message
R4037 - MissingTypeObject The schema 'Gallery' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L1798
R4037 - MissingTypeObject The schema 'GalleryUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L1812
R4037 - MissingTypeObject The schema 'GalleryProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L1826
R4037 - MissingTypeObject The schema 'GalleryIdentifier' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L1852
R4037 - MissingTypeObject The schema 'SharingProfile' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L1862
R4037 - MissingTypeObject The schema 'SharingProfileGroup' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L1893
R4037 - MissingTypeObject The schema 'GalleryApplication' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2018
R4037 - MissingTypeObject The schema 'GalleryApplicationUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2032
R4037 - MissingTypeObject The schema 'GalleryApplicationProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2046
R4037 - MissingTypeObject The schema 'GalleryApplicationVersion' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2097
R4037 - MissingTypeObject The schema 'GalleryApplicationVersionUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2111
R4037 - MissingTypeObject The schema 'GalleryApplicationVersionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2125
R4037 - MissingTypeObject The schema 'GalleryApplicationVersionPublishingProfile' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2147
R4037 - MissingTypeObject The schema 'UserArtifactSource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2270
R4037 - MissingTypeObject The schema 'UserArtifactManage' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2286
R4037 - MissingTypeObject The schema 'GalleryImage' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2320
R4037 - MissingTypeObject The schema 'GalleryImageUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2334
R4037 - MissingTypeObject The schema 'GalleryImageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2348
R4037 - MissingTypeObject The schema 'GalleryImageVersion' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2444
R4037 - MissingTypeObject The schema 'GalleryImageVersionUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2458
R4037 - MissingTypeObject The schema 'GalleryImageVersionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2472
R4037 - MissingTypeObject The schema 'GalleryArtifactPublishingProfileBase' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2497
R4037 - MissingTypeObject The schema 'TargetRegion' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2568
R4037 - MissingTypeObject The schema 'EncryptionImages' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2662
R4037 - MissingTypeObject The schema 'DataDiskImageEncryption' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2719
R4037 - MissingTypeObject The schema 'DiskImageEncryption' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2737
R4037 - MissingTypeObject The schema 'GalleryArtifactSource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2746
R4037 - MissingTypeObject The schema 'ManagedArtifact' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2757
R4037 - MissingTypeObject The schema 'GalleryImageVersionStorageProfile' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2777
R4037 - MissingTypeObject The schema 'GalleryArtifactVersionSource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: galleryRP/stable/2022-03-03/gallery.json#L2813
️⚠️Avocado: 1 Warnings warning [Detail]
Rule Message
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/compute/resource-manager/readme.md
tag: specification/compute/resource-manager/readme.md#tag-package-2022-03-03
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
  • The following tags are being changed in this PR
    • "https://github.com/Azure/azure-rest-api-specs/blob/16e9d7438427bd212997c1bc8744e33d36b60c0e/specification/compute/resource-manager/readme.md#tag-package-2022-03-03">compute/resource-manager/readme.md#package-2022-03-03
    • "https://github.com/Azure/azure-rest-api-specs/blob/16e9d7438427bd212997c1bc8744e33d36b60c0e/specification/compute/resource-manager/readme.md#tag-package-2022-03-03-only">compute/resource-manager/readme.md#package-2022-03-03-only
The following errors/warnings exist before current PR submission:
Rule Message
PreCheck/DuplicateSchema "readme":"compute/resource-manager/readme.md",
"tag":"package-2022-03-03",
"details":"Duplicate Schema named 'PurchasePlan' (1 differences):\n - properties.promotionCode: => "$ref":"#/components/schemas/schemas:1403",
"description":"The Offer Promotion Code."; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
"readme":"compute/resource-manager/readme.md",
"tag":"package-2022-03-03",
"details":"Error: 1 errors occured -- cannot continue."
⚠️ UnkownSecurityScheme "readme":"compute/resource-manager/readme.md",
"tag":"package-2022-03-03-only",
"details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
AzureKey,
Anonymous"
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @tiregan Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 30, 2022

    Swagger Generation Artifacts

    ️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=308113&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
    "detail":"Run.ps1 failed with exit code 1 "
    ️⚠️SDK Breaking Change Tracking warning [Detail]

    Breaking Changes Tracking

    ⚠️azure-sdk-for-go - armcompute - 4.0.0
    +	Field `URI` of struct `GalleryArtifactVersionSource` has been removed
    +	Type of `GalleryDataDiskImage.Source` has been changed from `*GalleryArtifactVersionSource` to `*GalleryDiskImageSource`
    +	Type of `GalleryDiskImage.Source` has been changed from `*GalleryArtifactVersionSource` to `*GalleryDiskImageSource`
    +	Type of `GalleryImageVersionStorageProfile.Source` has been changed from `*GalleryArtifactVersionSource` to `*GalleryArtifactVersionFullSource`
    +	Type of `GalleryOSDiskImage.Source` has been changed from `*GalleryArtifactVersionSource` to `*GalleryDiskImageSource`
    +	Type of `SharingProfile.CommunityGalleryInfo` has been changed from `interface{}` to `*CommunityGalleryInfo`
    ⚠️azure-sdk-for-js - @azure/arm-compute - 20.0.0
    +	Interface GalleryArtifactVersionSource no longer has parameter uri
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs] Generate from 9e4219f67f5ef74313da431f816ff45ca048bcb0. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/compute/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] No usable version of the libssl was found
      cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
      cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
      warn	Skip package processing as generation is failed
    ️❌ azure-sdk-for-python-track2 failed [Detail]
    • Failed [Logs] Generate from 9e4219f67f5ef74313da431f816ff45ca048bcb0. 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.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      cmderr	[automation_generate.sh] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.41.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.42.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.43.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.44.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] info    |    Loading AutoRest extension '@autorest/modelerfour' (4.19.3->4.19.3)
      cmdout	[automation_generate.sh] [Autorest] info    |    Loading AutoRest extension '@autorest/python' (5.16.0->5.16.0)
      cmdout	[automation_generate.sh] [Autorest] fatal   | Process() cancelled due to failure
      cmdout	[automation_generate.sh] [Autorest] error   | Batch/Error | Failure during batch task - {"tag":"package-2022-04-04-only"}  -- Error: Could not read 'file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/common.json'.
      cmdout	[automation_generate.sh] [Autorest] error   |   Error: Could not read 'file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/common.json'.
      cmdout	[automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
      warn	Skip package processing as generation is failed
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 9e4219f67f5ef74313da431f816ff45ca048bcb0. 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
    • ️✔️@azure/arm-compute [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation GalleryImages.getLatestVersionName
      info	[Changelog]   - Added Interface GalleryApplicationCustomAction
      info	[Changelog]   - Added Interface GalleryApplicationCustomActionParameter
      info	[Changelog]   - Added Interface GalleryArtifactSafetyProfileBase
      info	[Changelog]   - Added Interface GalleryImagesGetLatestVersionNameOptionalParams
      info	[Changelog]   - Added Interface LatestGalleryImageVersion
      info	[Changelog]   - Added Interface PolicyViolation
      info	[Changelog]   - Added Type Alias AvailabilitySet
      info	[Changelog]   - Added Type Alias AvailabilitySetUpdate
      info	[Changelog]   - Added Type Alias CapacityReservation
      info	[Changelog]   - Added Type Alias CapacityReservationGroup
      info	[Changelog]   - Added Type Alias CapacityReservationGroupUpdate
      info	[Changelog]   - Added Type Alias CapacityReservationInstanceViewWithName
      info	[Changelog]   - Added Type Alias CapacityReservationUpdate
      info	[Changelog]   - Added Type Alias CommunityGallery
      info	[Changelog]   - Added Type Alias CommunityGalleryImage
      info	[Changelog]   - Added Type Alias CommunityGalleryImageVersion
      info	[Changelog]   - Added Type Alias DataDiskImageEncryption
      info	[Changelog]   - Added Type Alias DedicatedHost
      info	[Changelog]   - Added Type Alias DedicatedHostGroup
      info	[Changelog]   - Added Type Alias DedicatedHostGroupUpdate
      info	[Changelog]   - Added Type Alias DedicatedHostInstanceViewWithName
      info	[Changelog]   - Added Type Alias DedicatedHostUpdate
      info	[Changelog]   - Added Type Alias Disk
      info	[Changelog]   - Added Type Alias DiskAccess
      info	[Changelog]   - Added Type Alias DiskEncryptionSet
      info	[Changelog]   - Added Type Alias DiskEncryptionSetParameters
      info	[Changelog]   - Added Type Alias DiskRestorePoint
      info	[Changelog]   - Added Type Alias Gallery
      info	[Changelog]   - Added Type Alias GalleryApplication
      info	[Changelog]   - Added Type Alias GalleryApplicationCustomActionParameterType
      info	[Changelog]   - Added Type Alias GalleryApplicationUpdate
      info	[Changelog]   - Added Type Alias GalleryApplicationVersion
      info	[Changelog]   - Added Type Alias GalleryApplicationVersionPublishingProfile
      info	[Changelog]   - Added Type Alias GalleryApplicationVersionSafetyProfile
      info	[Changelog]   - Added Type Alias GalleryApplicationVersionUpdate
      info	[Changelog]   - Added Type Alias GalleryArtifactVersionFullSource
      info	[Changelog]   - Added Type Alias GalleryDataDiskImage
      info	[Changelog]   - Added Type Alias GalleryDiskImageSource
      info	[Changelog]   - Added Type Alias GalleryImage
      info	[Changelog]   - Added Type Alias GalleryImagesGetLatestVersionNameResponse
      info	[Changelog]   - Added Type Alias GalleryImageUpdate
      info	[Changelog]   - Added Type Alias GalleryImageVersion
      info	[Changelog]   - Added Type Alias GalleryImageVersionPublishingProfile
      info	[Changelog]   - Added Type Alias GalleryImageVersionSafetyProfile
      info	[Changelog]   - Added Type Alias GalleryImageVersionUpdate
      info	[Changelog]   - Added Type Alias GalleryOSDiskImage
      info	[Changelog]   - Added Type Alias GalleryUpdate
      info	[Changelog]   - Added Type Alias Image_2
      info	[Changelog]   - Added Type Alias ImageDataDisk
      info	[Changelog]   - Added Type Alias ImageOSDisk
      info	[Changelog]   - Added Type Alias ImageReference
      info	[Changelog]   - Added Type Alias ImageUpdate
      info	[Changelog]   - Added Type Alias ManagedDiskParameters
      info	[Changelog]   - Added Type Alias NetworkInterfaceReference
      info	[Changelog]   - Added Type Alias OSDiskImageEncryption
      info	[Changelog]   - Added Type Alias PirSharedGalleryResource
      info	[Changelog]   - Added Type Alias PolicyViolationCategory
      info	[Changelog]   - Added Type Alias ProximityPlacementGroup
      info	[Changelog]   - Added Type Alias ProximityPlacementGroupUpdate
      info	[Changelog]   - Added Type Alias RequestRateByIntervalInput
      info	[Changelog]   - Added Type Alias RestorePoint
      info	[Changelog]   - Added Type Alias RestorePointCollection
      info	[Changelog]   - Added Type Alias RestorePointCollectionUpdate
      info	[Changelog]   - Added Type Alias RollingUpgradeStatusInfo
      info	[Changelog]   - Added Type Alias RunCommandDocument
      info	[Changelog]   - Added Type Alias SharedGallery
      info	[Changelog]   - Added Type Alias SharedGalleryDataDiskImage
      info	[Changelog]   - Added Type Alias SharedGalleryImage
      info	[Changelog]   - Added Type Alias SharedGalleryImageVersion
      info	[Changelog]   - Added Type Alias SharedGalleryOSDiskImage
      info	[Changelog]   - Added Type Alias Snapshot
      info	[Changelog]   - Added Type Alias SshPublicKeyResource
      info	[Changelog]   - Added Type Alias SshPublicKeyUpdateResource
      info	[Changelog]   - Added Type Alias SubResourceWithColocationStatus
      info	[Changelog]   - Added Type Alias ThrottledRequestsInput
      info	[Changelog]   - Added Type Alias VirtualMachine
      info	[Changelog]   - Added Type Alias VirtualMachineCaptureResult
      info	[Changelog]   - Added Type Alias VirtualMachineExtension
      info	[Changelog]   - Added Type Alias VirtualMachineExtensionImage
      info	[Changelog]   - Added Type Alias VirtualMachineExtensionUpdate
      info	[Changelog]   - Added Type Alias VirtualMachineImage
      info	[Changelog]   - Added Type Alias VirtualMachineImageResource
      info	[Changelog]   - Added Type Alias VirtualMachineRunCommand
      info	[Changelog]   - Added Type Alias VirtualMachineRunCommandUpdate
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSet
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSetExtension
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSetExtensionUpdate
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSetIPConfiguration
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSetNetworkConfiguration
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSetReimageParameters
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSetUpdate
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSetUpdateIPConfiguration
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSetUpdateNetworkConfiguration
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSetVM
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSetVMExtension
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSetVMExtensionUpdate
      info	[Changelog]   - Added Type Alias VirtualMachineScaleSetVMReimageParameters
      info	[Changelog]   - Added Type Alias VirtualMachineUpdate
      info	[Changelog]   - Interface TargetRegion has a new optional parameter excludeFromLatest
      info	[Changelog]   - Added Enum KnownPolicyViolationCategory
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Interface GalleryArtifactVersionSource no longer has parameter uri
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 9e4219f67f5ef74313da431f816ff45ca048bcb0. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️armcompute [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `GalleryDataDiskImage.Source` has been changed from `*GalleryArtifactVersionSource` to `*GalleryDiskImageSource`
      info	[Changelog] - Type of `GalleryDiskImage.Source` has been changed from `*GalleryArtifactVersionSource` to `*GalleryDiskImageSource`
      info	[Changelog] - Type of `GalleryImageVersionStorageProfile.Source` has been changed from `*GalleryArtifactVersionSource` to `*GalleryArtifactVersionFullSource`
      info	[Changelog] - Type of `GalleryOSDiskImage.Source` has been changed from `*GalleryArtifactVersionSource` to `*GalleryDiskImageSource`
      info	[Changelog] - Type of `SharingProfile.CommunityGalleryInfo` has been changed from `interface{}` to `*CommunityGalleryInfo`
      info	[Changelog] - Field `URI` of struct `GalleryArtifactVersionSource` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `GalleryApplicationCustomActionParameterTypeString`
      info	[Changelog] - New const `GalleryApplicationCustomActionParameterTypeConfigurationDataBlob`
      info	[Changelog] - New const `PolicyViolationCategoryOther`
      info	[Changelog] - New const `GalleryApplicationCustomActionParameterTypeLogOutputBlob`
      info	[Changelog] - New const `PolicyViolationCategoryCopyrightValidation`
      info	[Changelog] - New const `PolicyViolationCategoryImageFlaggedUnsafe`
      info	[Changelog] - New const `PolicyViolationCategoryIPTheft`
      info	[Changelog] - New function `PossibleGalleryApplicationCustomActionParameterTypeValues() []GalleryApplicationCustomActionParameterType`
      info	[Changelog] - New function `PossiblePolicyViolationCategoryValues() []PolicyViolationCategory`
      info	[Changelog] - New function `*GalleryImagesClient.GetLatestVersionName(context.Context, string, string, string, *GalleryImagesClientGetLatestVersionNameOptions) (GalleryImagesClientGetLatestVersionNameResponse, error)`
      info	[Changelog] - New struct `GalleryApplicationCustomAction`
      info	[Changelog] - New struct `GalleryApplicationCustomActionParameter`
      info	[Changelog] - New struct `GalleryApplicationVersionSafetyProfile`
      info	[Changelog] - New struct `GalleryArtifactSafetyProfileBase`
      info	[Changelog] - New struct `GalleryArtifactVersionFullSource`
      info	[Changelog] - New struct `GalleryDiskImageSource`
      info	[Changelog] - New struct `GalleryImageVersionSafetyProfile`
      info	[Changelog] - New struct `GalleryImagesClientGetLatestVersionNameOptions`
      info	[Changelog] - New struct `GalleryImagesClientGetLatestVersionNameResponse`
      info	[Changelog] - New struct `LatestGalleryImageVersion`
      info	[Changelog] - New struct `PolicyViolation`
      info	[Changelog] - New field `CustomActions` in struct `GalleryApplicationVersionPublishingProfile`
      info	[Changelog] - New field `PrivacyStatementURI` in struct `SharedGalleryImageProperties`
      info	[Changelog] - New field `Eula` in struct `SharedGalleryImageProperties`
      info	[Changelog] - New field `ExcludeFromLatest` in struct `TargetRegion`
      info	[Changelog] - New field `SafetyProfile` in struct `GalleryApplicationVersionProperties`
      info	[Changelog] - New field `CustomActions` in struct `GalleryApplicationProperties`
      info	[Changelog] - New field `SafetyProfile` in struct `GalleryImageVersionProperties`
      info	[Changelog]
      info	[Changelog] Total 6 breaking change(s), 38 additive change(s).
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Failed [Logs] Generate from 9e4219f67f5ef74313da431f816ff45ca048bcb0. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      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
    • compute/resource-manager [View full logs]  [Preview Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs] Generate from 9e4219f67f5ef74313da431f816ff45ca048bcb0. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • Az.compute [View full logs]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @tiregan, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @openapi-workflow-bot
    Copy link

    Hi @tiregan, 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.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @Sandido
    Copy link
    Contributor

    Sandido commented Jul 11, 2022

    The breaking change errors are concerning 2022-03-03 compared to 2021-10-01. This skips the 2022-01-03 version which had caused these breaking changes and were approved and merged.

    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    We have quite a few breaking changes introduced by this PR. I notice these because compute SDK of dotnet has already GA and we cannot introduce breaking changes to it (at lease for a few years). We will need to discuss a solution for these changes as well.
    We could defer that discussion since this is a dev branch.

    },
    "source": {
    "$ref": "#/definitions/GalleryArtifactVersionSource"
    "$ref": "#/definitions/GalleryDiskImageSource"
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    This change is a breaking change to SDKs and it is hard for our SDKs to resolve that.
    Could we change the implementation here a little bit to keep its original name?

    Copy link
    Contributor Author

    @tiregan tiregan Jul 26, 2022

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @ArcturusZhang
    The issue is that previously both GalleryImageVersionStorageProfile and GalleryDiskImage both refer to an object called GalleryArtifactVersionSource for the source field. This isn't really correct because they're logically different concepts. These changes fixes this issue.

    To illustrate this issue, the current swagger before these changes implies that you can use source.uri field for the GalleryImageVersionStorageProfile but that is incorrect. The uri field only exists on the GalleryDiskImage. These changes I made here fixed this issue and prevent the issue from getting worse as these two models evolve independently.

    This is not really a breaking change for the customer. If the customer where to specify the source.uri field for the GalleryImageVersionStorageProfile then the service would have rejected that request. We are not breaking any customer but instead fixing a previous mistake.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jul 27, 2022
    @ArcturusZhang ArcturusZhang merged commit aac0811 into Azure:feature/gallery-2022-03-03-2nd Aug 2, 2022
    Sandido added a commit that referenced this pull request Aug 2, 2022
    @Sandido Sandido mentioned this pull request Aug 19, 2022
    25 tasks
    @Sandido Sandido mentioned this pull request Aug 29, 2022
    11 tasks
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go CI-BreakingChange-JavaScript

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants