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

[Hub Generated] Publish private branch 'dev-devcenter-Microsoft.DevCenter-2022-11-11-preview' #21539

Conversation

nickdepinet
Copy link
Member

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

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.

@nickdepinet
Copy link
Member Author

The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/9539

@openapi-workflow-bot
Copy link

Hi, @nickdepinet 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 Nov 14, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 19 Warnings warning [Detail]
    compared swaggers (via Oad v0.10.2)] new version base version
    commonDefinitions.json 2022-11-11-preview(7702864) 2022-10-12-preview(main)
    devcenter.json 2022-11-11-preview(7702864) 2022-10-12-preview(main)
    vdi.json 2022-11-11-preview(7702864) 2022-10-12-preview(main)

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

    Rule Message
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '202'.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/vdi.json#L894:11
    ⚠️ 1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/vdi.json#L866:7
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/vdi.json#L866:7
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/commonDefinitions.json#L165:5
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/commonDefinitions.json#L165:5
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L2750:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/devcenter.json#L2705:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L2838:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/devcenter.json#L2785:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L3595:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/devcenter.json#L3535:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L3034:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/devcenter.json#L2978:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L3097:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/devcenter.json#L3041:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L3180:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/devcenter.json#L3124:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L2922:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/devcenter.json#L2866:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L3314:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/devcenter.json#L3258:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L3264:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/devcenter.json#L3208:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L3421:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/devcenter.json#L3365:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L3548:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/devcenter.json#L3488:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/commonDefinitions.json#L165:5
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/commonDefinitions.json#L165:5
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/vdi.json#L980:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/vdi.json#L973:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/vdi.json#L1425:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/vdi.json#L1418:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/vdi.json#L1174:9
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/vdi.json#L1167:9
    ⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.DevCenter/preview/2022-11-11-preview/commonDefinitions.json#L165:5
    Old: Microsoft.DevCenter/preview/2022-10-12-preview/commonDefinitions.json#L165:5
    ️️✔️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-preview-2022-11 package-preview-2022-11(7702864) default(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ LroExtension Operations with a 202 response should specify x-ms-long-running-operation: true.
    Location: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L2589
    ⚠️ 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: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L3169
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L3690
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.DevCenter/preview/2022-11-11-preview/vdi.json#L1004
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ CIRCULAR_REFERENCE The JSON file has a circular reference.
    readme: specification/devcenter/resource-manager/readme.md
    json: Microsoft.DevCenter/preview/2022-11-11-preview/vdi.json
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️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 Nov 14, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-python - track2_azure-mgmt-devcenter - 1.0.0b3
    +	Renamed operation NetworkConnectionsOperations.run_health_checks to NetworkConnectionsOperations.begin_run_health_checks
    azure-sdk-for-js - @azure/arm-devcenter - 1.0.0-beta.3
    +	Removed operation NetworkConnections.runHealthChecks
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 3b414eb. 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.2 -> 9.1.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.1.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.1.1` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-devcenter [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group CheckNameAvailabilityOperations
      info	[Changelog]   - Model DevBoxDefinition has a new parameter hibernate_support
      info	[Changelog]   - Model DevBoxDefinitionProperties has a new parameter hibernate_support
      info	[Changelog]   - Model DevBoxDefinitionUpdate has a new parameter hibernate_support
      info	[Changelog]   - Model DevBoxDefinitionUpdateProperties has a new parameter hibernate_support
      info	[Changelog]   - Model DevCenter has a new parameter dev_center_uri
      info	[Changelog]   - Model Project has a new parameter dev_center_uri
      info	[Changelog]   - Model ProjectProperties has a new parameter dev_center_uri
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Renamed operation NetworkConnectionsOperations.run_health_checks to NetworkConnectionsOperations.begin_run_health_checks
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 3b414eb. 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 available: 22.3 -> 22.3.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.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 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 3b414eb. 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-devcenter [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group CheckNameAvailability
      info	[Changelog]   - Added operation NetworkConnections.beginRunHealthChecks
      info	[Changelog]   - Added operation NetworkConnections.beginRunHealthChecksAndWait
      info	[Changelog]   - Added Interface CheckNameAvailabilityExecuteOptionalParams
      info	[Changelog]   - Added Interface CheckNameAvailabilityRequest
      info	[Changelog]   - Added Interface CheckNameAvailabilityResponse
      info	[Changelog]   - Added Interface ErrorAdditionalInfo
      info	[Changelog]   - Added Interface ErrorDetail
      info	[Changelog]   - Added Interface ErrorResponse
      info	[Changelog]   - Added Interface OperationStatusResult
      info	[Changelog]   - Added Type Alias CatalogSyncState
      info	[Changelog]   - Added Type Alias CheckNameAvailabilityExecuteResponse
      info	[Changelog]   - Added Type Alias CheckNameAvailabilityReason
      info	[Changelog]   - Added Type Alias HibernateSupport
      info	[Changelog]   - Added Type Alias ProvisioningState
      info	[Changelog]   - Added Type Alias SchedulesUpdateResponse
      info	[Changelog]   - Interface Catalog has a new optional parameter syncState
      info	[Changelog]   - Interface CatalogProperties has a new optional parameter syncState
      info	[Changelog]   - Interface DevBoxDefinition has a new optional parameter hibernateSupport
      info	[Changelog]   - Interface DevBoxDefinitionUpdate has a new optional parameter hibernateSupport
      info	[Changelog]   - Interface DevBoxDefinitionUpdateProperties has a new optional parameter hibernateSupport
      info	[Changelog]   - Interface DevCenter has a new optional parameter devCenterUri
      info	[Changelog]   - Interface NetworkConnectionsRunHealthChecksOptionalParams has a new optional parameter resumeFrom
      info	[Changelog]   - Interface NetworkConnectionsRunHealthChecksOptionalParams has a new optional parameter updateIntervalInMs
      info	[Changelog]   - Interface Project has a new optional parameter devCenterUri
      info	[Changelog]   - Interface ProjectProperties has a new optional parameter devCenterUri
      info	[Changelog]   - Class DevCenterClient has a new parameter checkNameAvailability
      info	[Changelog]   - Added Enum KnownCatalogSyncState
      info	[Changelog]   - Added Enum KnownCheckNameAvailabilityReason
      info	[Changelog]   - Added Enum KnownHibernateSupport
      info	[Changelog]   - Added Enum KnownProvisioningState
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Removed operation NetworkConnections.runHealthChecks
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 14, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Python track2_azure-mgmt-devcenter Create ApiView failed. Please ask PR assignee for help
    JavaScript @azure/arm-devcenter Create ApiView failed. Please ask PR assignee for help

    @tianxchen-ms tianxchen-ms merged commit 3b414eb into main Nov 15, 2022
    @tianxchen-ms tianxchen-ms deleted the published/nickdepinet/azure-rest-api-specs-pr/dev-devcenter-Microsoft.DevCenter-2022-11-11-preview branch November 15, 2022 05:34
    anandanthony pushed a commit to anandMicro/azure-rest-api-specs that referenced this pull request Dec 16, 2022
    kayousef-zz pushed a commit to kayousef-zz/azure-rest-api-specs that referenced this pull request Dec 21, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMReview CI-BreakingChange-JavaScript CI-BreakingChange-Python new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants