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

Azure Resource Graph - Resource Changes API 2020-09-01_preview update. #13052

Conversation

alexaloni
Copy link
Contributor

@alexaloni alexaloni commented Feb 19, 2021

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

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. What's the purpose of the update?
    • new service onboarding
    • [ X] new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • [X ] No, no need to refresh for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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

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

@openapi-workflow-bot
Copy link

Hi, @alexaloni 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 19, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 4 Warnings warning [Detail]

    Rule Message
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fetchSnapshots
    Location: Microsoft.ResourceGraph/preview/2020-09-01-preview/resourcechanges.json#L173
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Basic query
    Location: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcegraph.json#L76
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: First page query
    Location: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcegraph.json#L76
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Next page query
    Location: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcegraph.json#L76
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/resourcegraph/resource-manager/readme.md
    tag: specification/resourcegraph/resource-manager/readme.md#tag-package-preview-2020-09
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⚠️[Staging] Cross Version BreakingChange (Base on preview version): 14 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ 1026 - TypeChanged The new version has a different type 'array' than the previous one 'object'.
    New: Microsoft.ResourceGraph/preview/2020-09-01-preview/resourcechanges.json#L109:13
    Old: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcechanges.json#L109:13
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'resourceId' renamed or removed?
    New: Microsoft.ResourceGraph/preview/2020-09-01-preview/resourcechanges.json#L132:7
    Old: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcechanges.json#L132:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'resourceId' renamed or removed?
    New: Microsoft.ResourceGraph/preview/2020-09-01-preview/resourcechanges.json#L333:7
    Old: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcechanges.json#L311:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'changeId' renamed or removed?
    New: Microsoft.ResourceGraph/preview/2020-09-01-preview/resourcechanges.json#L333:7
    Old: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcechanges.json#L311:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'resourceId' renamed or removed?
    Old: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcechanges.json#L186:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'changeId' renamed or removed?
    Old: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcechanges.json#L186:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'beforeSnapshot' renamed or removed?
    Old: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcechanges.json#L186:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'afterSnapshot' renamed or removed?
    Old: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcechanges.json#L186:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'changeType' renamed or removed?
    Old: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcechanges.json#L186:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'propertyChanges' renamed or removed?
    Old: Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcechanges.json#L186:7
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️[Staging] SDK Track2 Validation: 9 Warnings warning [Detail]

    Rule Message
    ⚠️ PreCheck/SchemaMissingType "readme":"resourcegraph/resource-manager/readme.md",
    "tag":"package-preview-2020-09",
    "details":"The schema 'ResourceChangeData-beforeSnapshot' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"resourcegraph/resource-manager/readme.md",
    "tag":"package-preview-2020-09",
    "details":"The schema 'ResourceChangeData-afterSnapshot' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"resourcegraph/resource-manager/readme.md",
    "tag":"package-preview-2020-09",
    "details":"The schema 'QueryRequestOptions' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"resourcegraph/resource-manager/readme.md",
    "tag":"package-preview-2020-09",
    "details":"The schema 'FacetRequestOptions' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"resourcegraph/resource-manager/readme.md",
    "tag":"package-preview-2020-09",
    "details":"The schema 'OperationListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"resourcegraph/resource-manager/readme.md",
    "tag":"package-preview-2020-09",
    "details":"The schema 'Operation' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"resourcegraph/resource-manager/readme.md",
    "tag":"package-preview-2020-09",
    "details":"The schema 'Operation-display' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/CheckDuplicateSchemas "readme":"resourcegraph/resource-manager/readme.md",
    "tag":"package-preview-2020-09",
    "details":"Checking for duplicate schemas,
    this could take a (long) while. Run with --verbose for more detail."
    ⚠️ Modeler/MissingType "readme":"resourcegraph/resource-manager/readme.md",
    "tag":"package-preview-2020-09",
    "details":"The schema 'ResourceChangeList-$skipToken' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2020-09-01-preview/resourcechanges.json#/components/schemas/ResourceChangeList-$skipToken"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 19, 2021

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 11e051e. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️resourcegraph/mgmt/2019-04-01/resourcegraph [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/resourcegraph/mgmt/2018-09-01/resourcegraph [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Field `ETag` of struct `GraphQueryUpdateParameters` has been removed
      info	[Changelog] - Field `ETag` of struct `Resource` has been removed
      info	[Changelog] - Field `ETag` of struct `GraphQueryResource` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New field `Etag` in struct `GraphQueryUpdateParameters`
      info	[Changelog] - New field `Etag` in struct `Resource`
      info	[Changelog] - New field `Etag` in struct `GraphQueryResource`
      info	[Changelog]
      info	[Changelog] Total 3 breaking change(s), 3 additive change(s).
      info	[Changelog]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 11e051e. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/resourcegraph/resource-manager/readme.md
    • ️✔️@azure/arm-resourcegraph [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/resourceGraphClient.js → ./dist/arm-resourcegraph.js...
      cmderr	[npmPack] created ./dist/arm-resourcegraph.js in 188ms
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 11e051e. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/resourcegraph/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.ResourceGraph [View full logs]  [Release SDK Changes]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 11e051e. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6374 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/resourcegraph/resource-manager/readme.md
    • ️✔️resourcegraph [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager] npm WARN template-schema-validation-tools@1.0.0 No repository field.
      cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 11e051e. 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
    • ️✔️azure-mgmt-resourcegraph [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model QueryRequest has a new parameter management_group_id
      info	[Changelog]   - Added operation ResourceGraphClientOperationsMixin.resource_change_details
      info	[Changelog]   - Added operation ResourceGraphClientOperationsMixin.resources_history
      info	[Changelog]   - Added operation ResourceGraphClientOperationsMixin.resource_changes
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 11e051e. 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
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-02-25 03:06:56 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-resourcegraph"
      cmderr	[generate.py] 2021-02-25 03:06:56 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-02-25 03:06:56 INFO autorest --version=3.0.6369 --use=@autorest/java@4.0.17 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/resourcegraph/azure-resourcemanager-resourcegraph --java.namespace=com.azure.resourcemanager.resourcegraph   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/resourcegraph/resource-manager/readme.md
      cmderr	[generate.py] 2021-02-25 03:07:37 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-02-25 03:07:37 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-02-25 03:07:37 INFO [POM][Skip] pom already has module azure-resourcemanager-resourcegraph
      cmderr	[generate.py] 2021-02-25 03:07:37 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-02-25 03:07:37 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-02-25 03:07:37 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-resourcegraph [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-02-25 03:10:24 DEBUG Got artifact_id: azure-resourcemanager-resourcegraph
      cmderr	[Inst] 2021-02-25 03:10:24 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-02-25 03:10:24 DEBUG Got artifact: azure-resourcemanager-resourcegraph-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-02-25 03:10:24 DEBUG Got artifact: azure-resourcemanager-resourcegraph-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-02-25 03:10:24 DEBUG Got artifact: azure-resourcemanager-resourcegraph-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-02-25 03:10:24 DEBUG Match jar package: azure-resourcemanager-resourcegraph-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-02-25 03:10:24 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13052/azure-sdk-for-java/azure-resourcemanager-resourcegraph/azure-resourcemanager-resourcegraph-1.0.0-beta.1.jar\" -o azure-resourcemanager-resourcegraph-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-resourcegraph -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-resourcegraph-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @alexaloni, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @chiragg4u
    Copy link
    Contributor

    Looks good from ARM perspective, signing off.

    @chiragg4u
    Copy link
    Contributor

    Please try to resolve the warnings
    Also please go through the contribution checklist added as part of the review and mark them completed. This is a requirement before review can be continued.

    @chiragg4u chiragg4u added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Feb 19, 2021
    @raych1
    Copy link
    Member

    raych1 commented Feb 19, 2021

    @ArcturusZhang , can you check the if this PR causes GO SDK breaking change?

    @alexaloni
    Copy link
    Contributor Author

    alexaloni commented Feb 19, 2021

    Please try to resolve the warnings
    Also please go through the contribution checklist added as part of the review and mark them completed. This is a requirement before review can be continued.

    I reviewed the warnings - most of them are not critical and relates to resource history and resource graph , so not applicable to resource changes.

    @ArcturusZhang
    Copy link
    Member

    Breaking changes in Go come from previous PRs

    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    Azure#13052)
    
    * initial drop of previous version
    
    * publishing the actual change
    
    * pretty check update
    
    * updating response for resource change details to return list
    
    Co-authored-by: Alex Dubinkov <alexdu@microsoft.com>
    @JackTn JackTn deleted the dev/alexdu/ResourceGraph_ResourceChanges_API_2020-09-01_preview_v2 branch August 17, 2021 06:06
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants