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

Add new Automation API version #7603

Conversation

katherinebecker
Copy link

@katherinebecker katherinebecker commented Oct 23, 2019

This PR adds a new GA Automation API version for Update Management resources. The new API version adds a paged response when listing software update configurations. It also includes fixes to the description text and the response schema for listing software update configurations.

Latest improvements:

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

Contribution checklist:

  • I have reviewed the documentation for the workflow.
  • Validation tools were run on swagger spec(s) and have all been fixed in this PR.
  • The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

  • Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
  • adding/removing APIs.
  • adding/removing properties.
  • adding/removing API-version.
  • adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

  • If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
    Please follow the link to find more details on API review process.

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 23, 2019

azure-sdk-for-net

failed [Logs] [Expand Details]
  • Generate from a388aba with merge commit 0674e5df26be366f2b512db896849ae1ffc7c0b7. SDK Automation 13.0.17.20200918.2
    [AutoRest] realpath(): Permission denied
    [AutoRest] realpath(): Permission denied
    [AutoRest] realpath(): Permission denied
    [AutoRest] realpath(): Permission denied
    [AutoRest] realpath(): Permission denied
    [AutoRest] realpath(): Permission denied
  • Microsoft.Azure.Management.Automation [View full logs]  [Preview SDK Changes]
      Failed to create the package Microsoft.Azure.Management.Automation.
      Error: dotnet msbuild build.proj /t:CreateNugetPackage /p:Scope=automation /v:n /p:SkipTests=true , {} 

    @azuresdkci
    Copy link
    Contributor

    Can one of the admins verify this patch?

    @AutorestCI
    Copy link

    AutorestCI commented Oct 23, 2019

    Automation for azure-sdk-for-go

    Nothing to generate for azure-sdk-for-go

    Copy link
    Member

    @anthony-c-martin anthony-c-martin left a comment

    Choose a reason for hiding this comment

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

    Thanks for taking the time & care to organize the commits so clearly, and fixing up all the grammar/spelling issues! :)

    @anthony-c-martin anthony-c-martin added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 24, 2019
    @xseeseesee xseeseesee requested a review from vrdmr October 25, 2019 03:00
    @xseeseesee
    Copy link
    Contributor

    @vrdmr please review this PR as the code owner

    Copy link
    Member

    @vrdmr vrdmr left a comment

    Choose a reason for hiding this comment

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

    Minor comment. Everything else LGTM.

    Just to make sure that https://github.com/Azure/azure-resource-manager-schemas gets updated. (It's been couple of years I've worked on this now and don't know the current proces)

    ],
    "description": "Return list of software update configuration runs.",
    "externalDocs": {
    "url": "http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations"
    Copy link
    Member

    Choose a reason for hiding this comment

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

    You might want to verify these URLs. This one does not work.

    @xseeseesee
    Copy link
    Contributor

    @katherinebecker can you verify this url as per minor comment?

    @xseeseesee
    Copy link
    Contributor

    get confirmed from @katherinebecker , hold this PR until it's fixed.

    @xseeseesee
    Copy link
    Contributor

    @katherinebecker any progress?

    @katherinebecker
    Copy link
    Author

    @xccc-msft, I've fixed the URLs. We still need to wait on merging this PR because the new API version is not available yet. We are waiting on a deployment.

    @AutorestCI
    Copy link

    AutorestCI commented Nov 6, 2019

    Automation for azure-sdk-for-python

    A PR has been created for you based on this PR content.

    Once this PR will be merged, content will be added to your service PR:
    Azure/azure-sdk-for-python#8459

    @xseeseesee
    Copy link
    Contributor

    @katherinebecker can we merge this first and open new PR when your new API version available?

    @katherinebecker
    Copy link
    Author

    @xccc-msft, my understanding was that our documentation would be updated automatically after merging. Since we don't want the documentation showing an API version that isn't available yet, we'd need to wait before merging the PR. Is this correct?

    @xseeseesee xseeseesee added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Nov 15, 2019
    @xseeseesee
    Copy link
    Contributor

    @katherinebecker I'm not expert on this. Let's hold this PR until your side is ready. For now, I just add label of 'DoNotMerge' for the onhold status.

    @akning-ms
    Copy link
    Contributor

    Hi @katherinebecker, Is your service ready? as this PR is existing for a long time, can you close it?

    Copy the swagger specs for software update configurations, software update configuration runs, and software update configuration machines runs from the 2017-05-15-preview API version to a folder for the new 2019-06-01 API version. This will make it easier to review the changes for the new API version.
    Update the API version to 2019-06-01. Add a link to the next page of results in the response for getting the list of software update configurations. Tag the list responses as pageable for software update configurations, software update configuration runs, and software update configuration machine runs.
    Fix descriptions to use consistent capitalization and punctuation. Fix
    grammar errors.
    The schema used for the response for listing software update
    configurations did not match up with the examples or the actual response
    from the API. This updates the schema to match the examples and the API.
    Fix spelling mistake. Fix mistake in the example for creating a software
    update configuration so that it now matches the schema and actual API.
    Update external docs links to point to the current documentation
    @katherinebecker katherinebecker force-pushed the katwill/automationApiVersionUpdate branch from 00d15a1 to a388aba Compare July 31, 2020 01:12
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 31, 2020

    [Staging] Swagger Validation Report

    ️✔️BreakingChange [Detail]
     There are no breaking changes. 
    ️✔️LintDiff [Detail]
     Validation passes for LintDiff. 
    ️✔️Avocado [Detail]
     Validation passes for Avocado. 
    ️✔️ModelValidation [Detail]
     Validation passes for ModelValidation. 
    ️✔️SemanticValidation [Detail]
     Validation passes for SemanticValidation. 
    Posted by Swagger Pipeline | How to fix these errors?

    @azure-pipelines
    Copy link

    No commit pushedDate could be found for PR 7603 in repo Azure/azure-rest-api-specs

    @katherinebecker
    Copy link
    Author

    @akning-ms, this PR can be merged now

    }
    ],
    "nextLink": "https://management.azure.com:443/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns?api-version=2019-06-01&_=1508725900015&$skip=100"
    }
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    Resource name should be softwareUpdateConfigurationMachineRuns

    }
    }
    ],
    "nextLink": "https://management.azure.com:443/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns?api-version=2019-06-01&_=1508725900015&$skip=100"
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    Resource name should be softwareUpdateConfigurationMachineRuns

    @xseeseesee xseeseesee closed this Oct 19, 2020
    @xseeseesee xseeseesee reopened this Oct 19, 2020
    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 19, 2020

    Trenton Generation

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 19, 2020

    Azure CLI Extension Generation

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 19, 2020

    azure-resource-manager-schemas

    ⚠️ warning [Logs] [Expand Details]
    • ⚠️ Generate from a388aba with merge commit 0674e5df26be366f2b512db896849ae1ffc7c0b7. Schema Automation 13.0.17.20200918.2
      Failed to find any diff after autorest so no changed packages was found.

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 19, 2020

    azure-sdk-for-python

    ️✔️ succeeded [Logs] [Expand Details]
    • ️✔️ Generate from a388aba with merge commit 0674e5df26be366f2b512db896849ae1ffc7c0b7. SDK Automation 13.0.17.20200918.2
    • ️✔️azure-mgmt-automation [View full logs]  [Preview SDK Changes]
      [build_conf] INFO:packaging_tools:Building template azure-mgmt-automation
      [build_conf] INFO:packaging_tools.conf:Skipping default conf since the file exists
      [build_conf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
      [build_conf] INFO:packaging_tools:Template done azure-mgmt-automation
      [build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
      [build_package]   warnings.warn(msg)
      [build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
      [build_package]   warnings.warn(msg)
      [breaking_change_setup] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
      [ChangeLog] Size of delta 1.916% size of original (original: 150722 chars, delta: 2888 chars)
      [ChangeLog] **Features**
      [ChangeLog] 
      [ChangeLog]   - Model SoftwareUpdateConfigurationCollectionItem has a new parameter tasks

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 19, 2020

    azure-sdk-for-go

    ⚠️ warning [Logs] [Expand Details]

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 19, 2020

    azure-sdk-for-js

    ️✔️ succeeded [Logs] [Expand Details]
    • ️✔️ Generate from a388aba with merge commit 0674e5df26be366f2b512db896849ae1ffc7c0b7. SDK Automation 13.0.17.20200918.2
    • ️✔️@azure/arm-automation [View full logs]  [Preview SDK Changes]
      Only show 100 items here, please refer to log for details.
      [npmPack] npm WARN deprecated rollup-plugin-node-resolve@5.2.0: This package has been deprecated and is no longer maintained. Please use @rollup/plugin-node-resolve.
      [npmPack] npm WARN deprecated resolve-url@0.2.1: https://github.com/lydell/resolve-url#deprecated
      [npmPack] npm WARN deprecated urix@0.1.0: Please see https://github.com/lydell/urix#deprecated
      [npmPack] npm notice created a lockfile as package-lock.json. You should commit this file.
      [npmPack] loaded rollup.config.js with warnings
      [npmPack] (!) Unused external imports
      [npmPack] default imported from external module 'rollup' but never used
      [npmPack] 
      [npmPack] ./esm/automationClient.js → ./dist/arm-automation.js...
      [npmPack] created ./dist/arm-automation.js in 1.1s
      [npmPack] npm notice 
      [npmPack] npm notice package: @azure/arm-automation@10.0.0
      [npmPack] npm notice === Tarball Contents === 
      [npmPack] npm notice 4.1kB   esm/operations/activityOperations.js                             
      [npmPack] npm notice 539B    esm/models/activityOperationsMappers.js                          
      [npmPack] npm notice 3.5kB   esm/operations/agentRegistrationInformation.js                   
      [npmPack] npm notice 509B    esm/models/agentRegistrationInformationMappers.js                
      [npmPack] npm notice 563.1kB dist/arm-automation.js                                           
      [npmPack] npm notice 205.1kB dist/arm-automation.min.js                                       
      [npmPack] npm notice 8.9kB   esm/operations/automationAccountOperations.js                    
      [npmPack] npm notice 1.4kB   esm/models/automationAccountOperationsMappers.js                 
      [npmPack] npm notice 4.6kB   esm/automationClient.js                                          
      [npmPack] npm notice 2.6kB   esm/automationClientContext.js                                   
      [npmPack] npm notice 8.0kB   esm/operations/certificateOperations.js                          
      [npmPack] npm notice 1.3kB   esm/models/certificateOperationsMappers.js                       
      [npmPack] npm notice 8.0kB   esm/operations/connectionOperations.js                           
      [npmPack] npm notice 1.3kB   esm/models/connectionOperationsMappers.js                        
      [npmPack] npm notice 6.8kB   esm/operations/connectionTypeOperations.js                       
      [npmPack] npm notice 521B    esm/models/connectionTypeOperationsMappers.js                    
      [npmPack] npm notice 8.0kB   esm/operations/credentialOperations.js                           
      [npmPack] npm notice 1.4kB   esm/models/credentialOperationsMappers.js                        
      [npmPack] npm notice 8.1kB   esm/operations/dscCompilationJobOperations.js                    
      [npmPack] npm notice 1.3kB   esm/models/dscCompilationJobOperationsMappers.js                 
      [npmPack] npm notice 2.2kB   esm/operations/dscCompilationJobStream.js                        
      [npmPack] npm notice 453B    esm/models/dscCompilationJobStreamMappers.js                     
      [npmPack] npm notice 9.6kB   esm/operations/dscConfigurationOperations.js                     
      [npmPack] npm notice 1.4kB   esm/models/dscConfigurationOperationsMappers.js                  
      [npmPack] npm notice 8.3kB   esm/operations/dscNodeConfigurationOperations.js                 
      [npmPack] npm notice 1.3kB   esm/models/dscNodeConfigurationOperationsMappers.js              
      [npmPack] npm notice 6.5kB   esm/operations/dscNodeOperations.js                              
      [npmPack] npm notice 1.3kB   esm/models/dscNodeOperationsMappers.js                           
      [npmPack] npm notice 2.1kB   esm/operations/fields.js                                         
      [npmPack] npm notice 436B    esm/models/fieldsMappers.js                                      
      [npmPack] npm notice 7.1kB   esm/operations/hybridRunbookWorkerGroupOperations.js             
      [npmPack] npm notice 594B    esm/models/hybridRunbookWorkerGroupOperationsMappers.js          
      [npmPack] npm notice 345B    esm/models/index.js                                              
      [npmPack] npm notice 2.0kB   esm/operations/index.js                                          
      [npmPack] npm notice 11.2kB  esm/operations/jobOperations.js                                  
      [npmPack] npm notice 1.3kB   esm/models/jobOperationsMappers.js                               
      [npmPack] npm notice 6.5kB   esm/operations/jobScheduleOperations.js                          
      [npmPack] npm notice 541B    esm/models/jobScheduleOperationsMappers.js                       
      [npmPack] npm notice 4.2kB   esm/operations/jobStreamOperations.js                            
      [npmPack] npm notice 449B    esm/models/jobStreamOperationsMappers.js                         
      [npmPack] npm notice 1.9kB   esm/operations/keys.js                                           
      [npmPack] npm notice 422B    esm/models/keysMappers.js                                        
      [npmPack] npm notice 2.1kB   esm/operations/linkedWorkspaceOperations.js                      
      [npmPack] npm notice 440B    esm/models/linkedWorkspaceOperationsMappers.js                   
      [npmPack] npm notice 188.0kB esm/models/mappers.js                                            
      [npmPack] npm notice 7.8kB   esm/operations/moduleOperations.js                               
      [npmPack] npm notice 1.3kB   esm/models/moduleOperationsMappers.js                            
      [npmPack] npm notice 2.1kB   esm/operations/nodeCountInformation.js                           
      [npmPack] npm notice 462B    esm/models/nodeCountInformationMappers.js                        
      [npmPack] npm notice 5.3kB   esm/operations/nodeReports.js                                    
      [npmPack] npm notice 535B    esm/models/nodeReportsMappers.js                                 
      [npmPack] npm notice 3.4kB   esm/operations/objectDataTypes.js                                
      [npmPack] npm notice 445B    esm/models/objectDataTypesMappers.js                             
      [npmPack] npm notice 1.5kB   esm/operations/operations.js                                     
      [npmPack] npm notice 458B    esm/models/operationsMappers.js                                  
      [npmPack] npm notice 10.6kB  esm/models/parameters.js                                         
      [npmPack] npm notice 7.8kB   esm/operations/python2Package.js                                 
      [npmPack] npm notice 1.3kB   esm/models/python2PackageMappers.js                              
      [npmPack] npm notice 982B    rollup.config.js                                                 
      [npmPack] npm notice 7.6kB   esm/operations/runbookDraftOperations.js                         
      [npmPack] npm notice 553B    esm/models/runbookDraftOperationsMappers.js                      
      [npmPack] npm notice 11.4kB  esm/operations/runbookOperations.js                              
      [npmPack] npm notice 1.4kB   esm/models/runbookOperationsMappers.js                           
      [npmPack] npm notice 7.9kB   esm/operations/scheduleOperations.js                             
      [npmPack] npm notice 1.3kB   esm/models/scheduleOperationsMappers.js                          
      [npmPack] npm notice 4.5kB   esm/operations/softwareUpdateConfigurationMachineRuns.js         
      [npmPack] npm notice 570B    esm/models/softwareUpdateConfigurationMachineRunsMappers.js      
      [npmPack] npm notice 4.4kB   esm/operations/softwareUpdateConfigurationRuns.js                
      [npmPack] npm notice 617B    esm/models/softwareUpdateConfigurationRunsMappers.js             
      [npmPack] npm notice 7.2kB   esm/operations/softwareUpdateConfigurations.js                   
      [npmPack] npm notice 1.3kB   esm/models/softwareUpdateConfigurationsMappers.js                
      [npmPack] npm notice 8.1kB   esm/operations/sourceControlOperations.js                        
      [npmPack] npm notice 1.4kB   esm/models/sourceControlOperationsMappers.js                     
      [npmPack] npm notice 6.1kB   esm/operations/sourceControlSyncJobOperations.js                 
      [npmPack] npm notice 546B    esm/models/sourceControlSyncJobOperationsMappers.js              
      [npmPack] npm notice 4.7kB   esm/operations/sourceControlSyncJobStreams.js                    
      [npmPack] npm notice 527B    esm/models/sourceControlSyncJobStreamsMappers.js                 
      [npmPack] npm notice 2.1kB   esm/operations/statisticsOperations.js                           
      [npmPack] npm notice 452B    esm/models/statisticsOperationsMappers.js                        
      [npmPack] npm notice 6.8kB   esm/operations/testJobOperations.js                              
      [npmPack] npm notice 449B    esm/models/testJobOperationsMappers.js                           
      [npmPack] npm notice 4.1kB   esm/operations/testJobStreams.js                                 
      [npmPack] npm notice 444B    esm/models/testJobStreamsMappers.js                              
      [npmPack] npm notice 2.0kB   esm/operations/usages.js                                         
      [npmPack] npm notice 446B    esm/models/usagesMappers.js                                      
      [npmPack] npm notice 7.9kB   esm/operations/variableOperations.js                             
      [npmPack] npm notice 1.3kB   esm/models/variableOperationsMappers.js                          

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 19, 2020

    azure-sdk-for-java

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @xseeseesee
    Copy link
    Contributor

    Close this now as no update action taken recently. Please feel free to reopen if you still need to work on this PR. Thanks.

    @xseeseesee xseeseesee closed this Oct 28, 2020
    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 DoNotMerge <valid label in PR review process> use to hold merge after approval
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    8 participants