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] Review request for Microsoft.DelegatedNetwork to add version preview/2023-05-18-preview #25016

Merged

Conversation

isaac-dasan
Copy link
Member

@isaac-dasan isaac-dasan commented Jul 27, 2023

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

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

ARM API changes review

  • If you want for the ARM team to review this PR, you must add the ARMReview label.
  • The automation may automatically add the ARMReview label, if appropriate.
    If this happens, proceed according to guidance given in GitHub comments also added by the automation.

Breaking change review

If you have any breaking changes as defined in the Breaking Change Policy,
follow the process outlined in the High-level Breaking Change Process doc.

Getting help

@isaac-dasan isaac-dasan requested a review from tadelesh as a code owner July 27, 2023 17:35
@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 27, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
compared swaggers (via Oad v0.10.4)] new version base version
common-types.json 2023-06-27-preview(5cd43cf) 2021-03-15(main)
common-types.json 2023-06-27-preview(5cd43cf) 2023-05-18-preview(main)
controller.json 2023-06-27-preview(5cd43cf) 2021-03-15(main)
controller.json 2023-06-27-preview(5cd43cf) 2023-05-18-preview(main)
delegatedSubnets.json 2023-06-27-preview(5cd43cf) 2021-03-15(main)
delegatedSubnets.json 2023-06-27-preview(5cd43cf) 2023-05-18-preview(main)
operations.json 2023-06-27-preview(5cd43cf) 2021-03-15(main)
operations.json 2023-06-27-preview(5cd43cf) 2023-05-18-preview(main)
orchestrators.json 2023-06-27-preview(5cd43cf) 2021-03-15(main)
orchestrators.json 2023-06-27-preview(5cd43cf) 2023-05-18-preview(main)
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) new version base version
package-2023-06-27-preview package-2023-06-27-preview(5cd43cf) default(main)

The following errors/warnings exist before current PR submission:

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

Rule Message
PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/controller.json#L112
PutResponseSchemaDescription Description of 201 response code of a PUT operation MUST include term 'create'.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/controller.json#L112
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/controller.json#L163
ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/controller.json#L402
PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L115
PutResponseSchemaDescription Description of 201 response code of a PUT operation MUST include term 'create'.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L115
PatchResponseCode LRO PATCH must have 200 and 202 return codes.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L137
LroPatch202 The async patch operation should return 202.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L171
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L219
MissingTypeObject The schema 'ResourceUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L351
ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L409
PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/orchestrators.json#L112
PutResponseSchemaDescription Description of 201 response code of a PUT operation MUST include term 'create'.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/orchestrators.json#L112
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/orchestrators.json#L166
PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/orchestrators.json#L205
MissingTypeObject The schema 'OrchestratorResourceUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/orchestrators.json#L365
ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/orchestrators.json#L422
MissingTypeObject The schema 'OrchestratorIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/orchestrators.json#L466
⚠️ RequiredReadOnlySystemData The response of operation:'Controller_GetDetails' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/controller.json#L38
⚠️ RequiredReadOnlySystemData The response of operation:'Controller_Create' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/controller.json#L78
⚠️ RequiredReadOnlySystemData The response of operation:'Controller_Patch' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/controller.json#L178
⚠️ PatchInOperationName 'PATCH' operation 'Controller_Patch' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/controller.json#L188
⚠️ LocationMustHaveXmsMutability Property location must have 'x-ms-mutability':['read', 'create'] extension defined.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/controller.json#L330
⚠️ RequiredReadOnlySystemData The response of operation:'DelegatedSubnetService_GetDetails' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L38
⚠️ RequiredReadOnlySystemData The response of operation:'DelegatedSubnetService_PutDetails' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L78
⚠️ PutInOperationName 'PUT' operation 'DelegatedSubnetService_PutDetails' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L91
⚠️ RequiredReadOnlySystemData The response of operation:'DelegatedSubnetService_PatchDetails' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L137
⚠️ PatchInOperationName 'PATCH' operation 'DelegatedSubnetService_PatchDetails' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L147
⚠️ LocationMustHaveXmsMutability Property location must have 'x-ms-mutability':['read', 'create'] extension defined.
Location: Microsoft.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L337
⚠️ 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.DelegatedNetwork/preview/2023-06-27-preview/delegatedSubnets.json#L464
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @isaac-dasan! Thank you for your pull request. To help get your PR merged:

  • Ensure you reviewed the checklists in the PR description.
  • Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval.
  • For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
  • @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 27, 2023

    Swagger Generation Artifacts

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

    Breaking Changes Tracking



    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 68ba30d. 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	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/dnc/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.DelegatedNetwork [View full logs]  [Release SDK Changes]
      warn	Skip artifact folder because it doesn't exist: artifacts/packages
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 68ba30d. 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]  New minor version of npm available! 9.6.7 -> 9.8.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-dnc [View full logs]  [Release SDK Changes]
      info	[Changelog]   - Initial Release
    ️⚠️ azure-sdk-for-java warning [Detail]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 68ba30d. 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/delegatednetwork/armdelegatednetwork [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New enum type `ControllerPurpose` with values `ControllerPurposeProd`, `ControllerPurposeTest`
      info	[Changelog] - New field `Purpose` in struct `DelegatedControllerProperties`
      info	[Changelog] - New field `AllocationBlockPrefixSize` in struct `DelegatedSubnetProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 5 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 68ba30d. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from 68ba30d. 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
      SSL error: syscall failure: Broken pipe
      Error: SSL error: syscall failure: Broken pipe
    • ️✔️Az.dnc.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.dnc.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 27, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/delegatednetwork/armdelegatednetwork https://apiview.dev/Assemblies/Review/03f66738b6174fa68a8b7a7c760d5f79
    Java azure-resourcemanager-delegatednetwork https://apiview.dev/Assemblies/Review/b5256e7f5bc442f3bbf508cb0d056d57

    @visingla-ms visingla-ms added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jul 27, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 27, 2023
    @openapi-workflow-bot
    Copy link

    Hi @isaac-dasan! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic ValidationFix-SemanticValidation-ErrorHigh
    Model ValidationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffHigh

    If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 16, 2023

    Next Steps to Merge

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

    ✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

    @isaac-dasan
    Copy link
    Member Author

    /pr RequestMerge

    @rkmanda
    Copy link
    Member

    rkmanda commented Aug 17, 2023

    /azp run

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 17, 2023

    Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @rkmanda
    Copy link
    Member

    rkmanda commented Aug 17, 2023

    waiting for required checks to pass

    @rkmanda
    Copy link
    Member

    rkmanda commented Aug 17, 2023

    /azp run

    @openapi-pipeline-app
    Copy link

    Automatic PR validation started. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @rkmanda rkmanda merged commit 68ba30d into main Aug 17, 2023
    @rkmanda rkmanda deleted the isaac-dasan-dnc-Microsoft.DelegatedNetwork-2023-05-18-preview-4 branch August 17, 2023 23:07
    @openapi-pipeline-app
    Copy link

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants