Skip to content

Comments

[Hub Generated] Publish private branch 'dev-devcenter-Microsoft.DevCenter-2022-08-01-preview_renamerp'#19708

Merged
raych1 merged 5 commits intomainfrom
published/Azure/azure-rest-api-specs-pr/dev-devcenter-Microsoft.DevCenter-2022-08-01-preview_renamerp
Jul 14, 2022
Merged

[Hub Generated] Publish private branch 'dev-devcenter-Microsoft.DevCenter-2022-08-01-preview_renamerp'#19708
raych1 merged 5 commits intomainfrom
published/Azure/azure-rest-api-specs-pr/dev-devcenter-Microsoft.DevCenter-2022-08-01-preview_renamerp

Conversation

@tbyfield
Copy link
Member

@tbyfield tbyfield commented Jul 7, 2022

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.

@tbyfield
Copy link
Member Author

tbyfield commented Jul 7, 2022

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/7520

@openapi-workflow-bot
Copy link

Hi, @tbyfield 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 Jul 7, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 6 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-08-01-preview package-2022-08-01-preview(e0ec7b0) default(main)

    The following errors/warnings are introduced by current PR:

    Rule Message
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.DevCenter/preview/2022-08-01-preview/devcenter.json#L3500
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'OperationStatuses_Get' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.DevCenter/preview/2022-08-01-preview/devcenter.json#L2496
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'versions' with immediate parent 'Image', must have a list by immediate parent operation.
    Location: Microsoft.DevCenter/preview/2022-08-01-preview/devcenter.json#L2974
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'environmentTypes' with immediate parent 'Project', must have a list by immediate parent operation.
    Location: Microsoft.DevCenter/preview/2022-08-01-preview/devcenter.json#L3140
    ⚠️ 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: Microsoft.DevCenter/preview/2022-08-01-preview/devcenter.json#L3005
    ⚠️ R4021 - DescriptionAndTitleMissing 'LocalAdminStatus' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.DevCenter/preview/2022-08-01-preview/vdi.json#L985
    ️⚠️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-08-01-preview/vdi.json
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/e0ec7b0ffe08aeb9750f24000f24351ae55babd3/specification/devcenter/resource-manager/readme.md#tag-package-2022-08-01-preview">devcenter/resource-manager/readme.md#package-2022-08-01-preview
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"devcenter/resource-manager/readme.md",
    "tag":"package-2022-08-01-preview",
    "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.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 7, 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=304639&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
    "detail":"npm ERR! code E401"
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c953973. 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]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c953973. 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
      cmderr	[automation_init.sh] npm WARN deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh] deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] WARN deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
      cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      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]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    Posted by Swagger Pipeline | How to fix these errors?

    …pi-specs-pr#7688. 1) update environment creator role assignment in spec to match user role assignments. 2) add domainJoinType to attached network.
    @raych1
    Copy link
    Member

    raych1 commented Jul 8, 2022

    @tbyfield , can you fix spellCheck CI check failures?

    @openapi-workflow-bot
    Copy link

    Hi @tbyfield, 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.

    @raych1
    Copy link
    Member

    raych1 commented Jul 12, 2022

    @dw511214992 , can you check on the JS sdk check error?

    @tbyfield , let me know if this PR is ready to merge?

    @dw511214992
    Copy link
    Member

    @qiaozha @MaryGao Please check why the generated js sdk builds failed.

    @tbyfield
    Copy link
    Member Author

    @raych1 yes, when you ready please merge this PR. I updated the title per the suggestion, and fixed a new RPaaS violdation. The ApiDocReview failure looks to me to be a pipeline issue and not directly related to this PR.

    @raych1 raych1 merged commit c953973 into main Jul 14, 2022
    @raych1 raych1 deleted the published/Azure/azure-rest-api-specs-pr/dev-devcenter-Microsoft.DevCenter-2022-08-01-preview_renamerp branch July 14, 2022 00:57
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    None yet

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants