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

Adding properties to WhatIfChange #31006

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

davidcho23
Copy link
Contributor

@davidcho23 davidcho23 commented Oct 14, 2024

…ous API version

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

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

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • 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 OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • 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:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

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.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copy link

openapi-pipeline-app bot commented Oct 14, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR has ARMChangesRequested label. Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    Automation should then add WaitForARMFeedback label.
    ❗If you don't have permissions to remove the label, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide. In addition, refer to step 4 in the PR workflow diagram

Copy link

openapi-pipeline-app bot commented Oct 14, 2024

Generated ApiView

Language Package Name ApiView Link
Java azure-resourcemanager-resources-generated https://apiview.dev/Assemblies/Review/69d90a3c09dd41d388271d10f46fbed8?revisionId=5114c0aa53754f2ab08ddf1b8680f43a
Go sdk/resourcemanager/resources/armchanges There is no API change compared with the previous version
Go sdk/resourcemanager/databoundaries/armdataboundaries https://apiview.dev/Assemblies/Review/3b27b75210404b5dbf9ebc3f9c788414?revisionId=d87c5942cb8f47b0a92d2b617377d20a
Go sdk/resourcemanager/resources/armdeploymentscripts https://apiview.dev/Assemblies/Review/7baaae1d269a4ed7912f863425ad71a0?revisionId=8ddd2c355898415f8aa7f5c3c2796ec5
Go sdk/resourcemanager/resources/armdeploymentstacks There is no API change compared with the previous version
Go sdk/resourcemanager/resources/armfeatures There is no API change compared with the previous version
Go sdk/resourcemanager/resources/armlinks There is no API change compared with the previous version
Go sdk/resourcemanager/resources/armlocks There is no API change compared with the previous version
Go sdk/resourcemanager/resources/armmanagedapplications There is no API change compared with the previous version
Go sdk/resourcemanager/resources/armpolicy https://apiview.dev/Assemblies/Review/307c195eccc840d1b92e75be6564ba10?revisionId=7dc8448813ed41da8404ce2049c7f3bc
Go sdk/resourcemanager/resources/armresources https://apiview.dev/Assemblies/Review/12843540e3a1467ea73d364496b55308?revisionId=add924bf11a24b89bd7c40fcb13d3835
Go sdk/resourcemanager/resources/armsubscriptions There is no API change compared with the previous version
Go sdk/resourcemanager/resources/armtemplatespecs There is no API change compared with the previous version
.Net Azure.ResourceManager.Resources There is no API change compared with the previous version
JavaScript @azure/arm-changes https://apiview.dev/Assemblies/Review/357d9a1c28c440e8a1bd4912e73149e7?revisionId=56c3cf1700ed4c189e695270d2d0fcb3
JavaScript @azure/arm-databoundaries https://apiview.dev/Assemblies/Review/f3358ffd08e0441faf640392a862557f?revisionId=1d8e69d60aa24489a0b3660a18ae2050
JavaScript @azure/arm-features https://apiview.dev/Assemblies/Review/cdac4d1c1fa1462bb53e5df0b43b1fd8?revisionId=38410ce8c113472881cadafc91010a82
JavaScript @azure/arm-links https://apiview.dev/Assemblies/Review/fab6f39d3aa4438bbcf44202497c232d?revisionId=ffa6e0e3ab6f4c368c4fb7f6ac459e6d
JavaScript @azure/arm-locks https://apiview.dev/Assemblies/Review/5032ea8e14d64cd0adc264676495aba7?revisionId=27349ebd31724e0da0f5d4341870ce48
JavaScript @azure/arm-managedapplications https://apiview.dev/Assemblies/Review/13cbf64f04e64947ba72af718bdd91bf?revisionId=f5f748ddf1b6467ea64c78d88c4e2d18
JavaScript @azure/arm-policy https://apiview.dev/Assemblies/Review/cda5950570364aba98f6c682240aed30?revisionId=69077e0567354b7b9461c61b07d35098
JavaScript @azure/arm-resources-subscriptions There is no API change compared with the previous version
JavaScript @azure/arm-resources https://apiview.dev/Assemblies/Review/2afa29187fb74b96ba17874edd55e007?revisionId=b0bf96eef1f942829e5da374eb836504
JavaScript @azure/arm-resourcesdeploymentstacks There is no API change compared with the previous version
JavaScript @azure/arm-templatespecs https://apiview.dev/Assemblies/Review/fc04625bf7df4e6e97f03f7aae3c05b7?revisionId=a35b087e9a8c46c6879ecc7d037cbc71

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 14, 2024
This was referenced Oct 14, 2024
"type": "string",
"description": "Symbolic Name"
},
"idnetifiers": {
Copy link
Member

Choose a reason for hiding this comment

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

Typo here

@@ -6447,6 +6447,18 @@
"type": "string",
"description": "Resource ID"
},
"deploymentId": {
"type": "string",
"description": "Deployment ID"
Copy link
Member

Choose a reason for hiding this comment

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

Could you expand on these descriptions a bit? They will be used to generate comments & documentation, so they're used by customers to discover what these properties mean.

For example: "The resource id of the Deployment responsible for this resource change."

@davidcho23 davidcho23 changed the title Initial commit of new API version with resources.json file from previ… Adding properties to WhatIfChange Oct 16, 2024
@davidcho23 davidcho23 added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Oct 17, 2024
@ramoka178
Copy link
Contributor

Please fix the Swagger ModelValidation and Swagger Avocado errors too.

@ramoka178 ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 22, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChange-JavaScript-Sdk new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants