Skip to content

Remove <br> syntax from swagger files #23111

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Remove <br> syntax from swagger files #23111

wants to merge 1 commit into from

Conversation

Sandido
Copy link
Contributor

@Sandido Sandido commented Mar 15, 2023

There has been a long conversation about how to handle these. In the Rest API docs they are fine, but in the SDK docs (all SDKs) they appear as variations on this:
<br>

I have rewritten all descriptions that could be rewritten without hampering the Rest API doc descriptions.

ARM API Information (Control Plane)

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

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

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

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

@openapi-workflow-bot
Copy link

Hi, @Sandido 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. [email protected]

    @ghost ghost added the Compute label Mar 15, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 15, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    communityGallery.json 2022-03-03(71ad19e) 2022-03-03(main)
    gallery.json 2022-03-03(71ad19e) 2022-03-03(main)
    sharedGallery.json 2022-03-03(71ad19e) 2022-03-03(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.0.0) new version base version
    package-2022-11-01 package-2022-11-01(71ad19e) package-2022-11-01(main)
    package-2022-09-04 package-2022-09-04(71ad19e) package-2022-09-04(main)
    package-2022-03-03 package-2022-03-03(71ad19e) package-2022-03-03(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L37
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L37
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L37
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
    ❌ ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
    ❌ ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
    ❌ ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ❌ ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ❌ ResourceNameRestriction The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ❌ ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ❌ ResourceNameRestriction The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ❌ ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ❌ ResourceNameRestriction The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L172
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L172
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L172
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
    ❌ ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
    ❌ ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
    ❌ ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
    ❌ ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
    ❌ MissingTypeObject The schema 'PirCommunityGalleryResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L267
    ❌ MissingTypeObject The schema 'PirCommunityGalleryResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L267
    ❌ MissingTypeObject The schema 'PirCommunityGalleryResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L267
    ️⚠️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-11-01
    ️️✔️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]
    ️❌ModelValidation: 61 Errors, 0 Warnings failed [Detail]

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

    Rule Message
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Create.json#L16:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Create.json#L29:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Create.json#L42:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Create_WithSharingProfile.json#L19:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Create_WithSharingProfile.json#L35:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Create_WithSharingProfile.json#L51:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Create_SoftDeletionEnabled.json#L19:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Create_SoftDeletionEnabled.json#L35:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Create_SoftDeletionEnabled.json#L51:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/CommunityGallery_Create.json#L25:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/CommunityGallery_Create.json#L47:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/CommunityGallery_Create.json#L69:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Get.json#L10:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Get_WithSelectPermissions.json#L11:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Get_WithExpandSharingProfileGroups.json#L11:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L1738:16
    ExampleUrl: 2022-03-03/examples/galleryExamples/CommunityGallery_Get.json#L10:15
    ❌ LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L261:22
    ExampleUrl: 2022-03-03/examples/galleryExamples/Gallery_Delete.json
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L2260:21
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImage_Create.json#L24:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L2260:21
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImage_Create.json#L41:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L2260:21
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImage_Create.json#L58:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L2260:21
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImage_Get.json#L11:15
    ❌ LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L503:22
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImage_Delete.json
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L2384:28
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImageVersion_Create.json#L70:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L2384:28
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImageVersion_Create.json#L154:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L2384:28
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImageVersion_Create.json#L238:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L2384:28
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json#L74:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L2384:28
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json#L153:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L2384:28
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json#L232:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L2384:28
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImageVersion_Create_WithVmAsSource.json#L70:15
    ❌ MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: GalleryRP/stable/2022-03-03/gallery.json#L2384:28
    ExampleUrl: 2022-03-03/examples/galleryExamples/GalleryImageVersion_Create_WithVmAsSource.json#L154:15
    ️️✔️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.
    ️️✔️PR Summary succeeded [Detail] [Expand] 
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 15, 2023 •
    edited
    Loading

    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-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 2245c872dee3730ed770a4ca508a1a450200c231. 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
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    • ️✔️Azure.ResourceManager.Compute [View full logs]  [Preview SDK Changes] 
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 2245c872dee3730ed770a4ca508a1a450200c231. 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]
cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.6.2
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.2>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-compute [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter computer_name
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter hyper_v_generation
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter os_name
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter os_version
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Model VirtualMachineScaleSetIPConfiguration no longer has parameter id
info	[Changelog]   - Model VirtualMachineScaleSetNetworkConfiguration no longer has parameter id
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 2245c872dee3730ed770a4ca508a1a450200c231. 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] 
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter computerName
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter hyperVGeneration
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter osName
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter osVersion
info	[Changelog]   - Enum KnownStorageAccountType has a new value StandardSSDLRS
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 2245c872dee3730ed770a4ca508a1a450200c231. 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
    • ️✔️sdk/resourcemanager/compute/armcompute [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Field `ID` of struct `VirtualMachineScaleSetIPConfiguration` has been removed
info	[Changelog] - Field `ID` of struct `VirtualMachineScaleSetNetworkConfiguration` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New value `StorageAccountTypeStandardSSDLRS` added to type alias `StorageAccountType`
info	[Changelog] - New field `ComputerName` in struct `VirtualMachineScaleSetVMInstanceView`
info	[Changelog] - New field `HyperVGeneration` in struct `VirtualMachineScaleSetVMInstanceView`
info	[Changelog] - New field `OSName` in struct `VirtualMachineScaleSetVMInstanceView`
info	[Changelog] - New field `OSVersion` in struct `VirtualMachineScaleSetVMInstanceView`
info	[Changelog]
info	[Changelog] Total 2 breaking change(s), 2 additive change(s).
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 2245c872dee3730ed770a4ca508a1a450200c231. 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] 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 [View full logs]  [Preview Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • ❌Code Generator Failed [Logs] Generate from 2245c872dee3730ed770a4ca508a1a450200c231. SDK Automation 14.0.0 
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
error	Script return with result [failed] code [2] signal [null] cwd [azure-powershell]: sh ./tools/SwaggerCI/init.sh
warn	File azure-powershell_tmp/initOutput.json not found to read
error	Fatal error: ENOENT: no such file or directory, open 'azure-powershell_tmp/generateInput.json'
ENOENT: no such file or directory, open 'azure-powershell_tmp/generateInput.json'
Error: ENOENT: no such file or directory, open 'azure-powershell_tmp/generateInput.json'
    at Object.openSync (node:fs:590:3)
    at Object.writeFileSync (node:fs:2202:35)
    at Object.exports.writeTmpJsonFile (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/utils/fsUtils.js:121:18)
    at workflowCallGenerateScript (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:474:15)
    at workflowHandleReadmeMdOrCadlProject (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:205:46)
    at async Object.exports.workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:94:9)
    at async Object.exports.sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:191:13)
    at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 15, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    swagger Microsoft.Compute https://apiview.dev/Assemblies/Review/1698a3cc5b5442278f093442c2a713fe
    Go sdk/resourcemanager/compute/armcompute Create ApiView failed. Please ask PR assignee for help
    Java azure-resourcemanager-compute-generated https://apiview.dev/Assemblies/Review/5c5a501fbcba4fb58f5417f07795374c
    .Net Azure.ResourceManager.Compute There is no API change compared with the previous version
    JavaScript @azure/arm-compute https://apiview.dev/Assemblies/Review/29b30faefa7b4516a5cf9830622e9051

    @azure-sdk azure-sdk mentioned this pull request Mar 15, 2023
    Closed
    This was referenced Mar 15, 2023
    Closed
    Closed
    Closed
    Draft
    Closed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @dkulkarni-ms dkulkarni-ms Awaiting requested review from dkulkarni-ms dkulkarni-ms will be requested when the pull request is marked ready for review dkulkarni-ms is a code owner

    @haagha haagha Awaiting requested review from haagha haagha will be requested when the pull request is marked ready for review haagha is a code owner

    @MS-syh2qs MS-syh2qs Awaiting requested review from MS-syh2qs MS-syh2qs will be requested when the pull request is marked ready for review MS-syh2qs is a code owner

    @grizzlytheodore grizzlytheodore Awaiting requested review from grizzlytheodore grizzlytheodore will be requested when the pull request is marked ready for review grizzlytheodore is a code owner

    @mabhard mabhard Awaiting requested review from mabhard mabhard will be requested when the pull request is marked ready for review mabhard is a code owner

    At least 1 approving review is required to merge this pull request.

    Assignees
    No one assigned
    Labels
    Compute resource-manager
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @Sandido @AzureRestAPISpecReview