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.

Sign up for GitHub

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

Jump to bottom

[Batch] Fix: Readded incorrectly removed Location/Retry-After headers #12560

Merged
merged 1 commit into from
Jan 23, 2021
Merged

[Batch] Fix: Readded incorrectly removed Location/Retry-After headers #12560

merged 1 commit into from
Jan 23, 2021

Conversation

dpwatrous
Copy link
Member

@dpwatrous dpwatrous commented Jan 22, 2021 •
edited
Loading

Re-added Location and Retry-After headers to private endpoint connection update operation. Removing these from the swagger was incorrect and caused a breaking change in the C# SDK: Azure/azure-sdk-for-net#17962

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
    • 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
    • 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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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.

@dpwatrous
[Batch] Fix: Readded incorrectly removed Location/Retry-After headers
1176fd1 
Re-added Location and Retry-After headers to private endpoint connection update operation. Removing these from the swagger was incorrect and caused a breaking change in the C# SDK.
@openapi-workflow-bot
Copy link

Hi, @dpwatrous 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 Jan 22, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.

    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️[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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 22, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from de1388e. 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-01-23 03:47:24 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-batch"
cmderr	[generate.py] 2021-01-23 03:47:24 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-01-23 03:47:24 INFO autorest --version=3.0.6350 --use=@autorest/java@4.0.11 --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/batch/azure-resourcemanager-batch --java.namespace=com.azure.resourcemanager.batch   --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/batch/resource-manager/readme.md
cmderr	[generate.py] 2021-01-23 03:48:16 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-01-23 03:48:16 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-01-23 03:48:16 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-01-23 03:48:16 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-01-23 03:48:16 INFO [POM][Skip] pom already has module sdk/batch
cmderr	[generate.py] 2021-01-23 03:48:16 INFO [POM][Success] Write to root pom
cmderr	[generate.py] WARNING: An illegal reflective access operation has occurred
cmderr	[generate.py] WARNING: Illegal reflective access by org.codehaus.groovy.reflection.ReflectionUtils (file:/home/vsts/.m2/repository/org/codehaus/groovy/groovy/3.0.0-beta-2/groovy-3.0.0-beta-2-indy.jar) to method java.util.Collections$UnmodifiableCollection.toString()
cmderr	[generate.py] WARNING: Please consider reporting this to the maintainers of org.codehaus.groovy.reflection.ReflectionUtils
cmderr	[generate.py] WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
cmderr	[generate.py] WARNING: All illegal access operations will be denied in a future release
    • ️✔️azure-resourcemanager-batch [View full logs]  [Release SDK Changes] 
      cmderr	[Inst] 2021-01-23 03:51:46 DEBUG Got artifact_id: azure-resourcemanager-batch
cmderr	[Inst] 2021-01-23 03:51:46 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-01-23 03:51:46 DEBUG Got artifact: azure-resourcemanager-batch-1.0.0-beta.1.jar
cmderr	[Inst] 2021-01-23 03:51:46 DEBUG Match jar package: azure-resourcemanager-batch-1.0.0-beta.1.jar
cmderr	[Inst] 2021-01-23 03:51:46 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12560/azure-sdk-for-java/azure-resourcemanager-batch/azure-resourcemanager-batch-1.0.0-beta.1.jar\" -o azure-resourcemanager-batch-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-batch -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-batch-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from de1388e. 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/batch/resource-manager/readme.md
    • ️✔️@azure/arm-batch [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/batchManagementClient.js → ./dist/arm-batch.js...
cmderr	[npmPack] created ./dist/arm-batch.js in 416ms
    ️️✔️ azure-sdk-for-python succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from de1388e. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	npx n 12
command	python3 -m venv venv
command	pip install --upgrade setuptools wheel pip
command	pip install pathlib jinja2 msrestazure
command	autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/batch/resource-manager/readme.md
    • ️✔️azure-mgmt-batch [View full logs]  [Release SDK Changes] Breaking Change Detected
      cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-batch
cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
cmderr	[buildConf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-batch
cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.batch
cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.batch
cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.batch
cmderr	[changelogReport] INFO:__main__:Report written to sdk/batch/azure-mgmt-batch/code_reports/latest/report.json
cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-batch on PyPI
cmderr	[changelogReportLatest] INFO:__main__:Got ['0.30.0rc2', '0.30.0rc3', '0.30.0rc4', '0.30.0rc5', '1.0.0', '2.0.0', '3.0.0', '3.0.1', '4.0.0', '4.1.0', '5.0.0', '5.0.1', '6.0.0', '7.0.0', '8.0.0', '8.0.1', '9.0.0', '14.0.0b1', '14.0.0']
cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
cmderr	[changelogReportLatest] INFO:__main__:Installing version 9.0.0 of azure-mgmt-batch in a venv
cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.batch
cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.batch
cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.batch
cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/batch/azure-mgmt-batch/code_reports/9.0.0/report.json
cmdout	[Changelog] Size of delta 6.538% size of original (original: 58671 chars, delta: 3836 chars)
cmdout	[Changelog] **Features**
cmdout	[Changelog]   - Model VirtualMachineConfiguration has a new parameter node_placement_configuration
cmdout	[Changelog]   - Model VirtualMachineConfiguration has a new parameter extensions
cmdout	[Changelog]   - Model Pool has a new parameter identity
cmdout	[Changelog]   - Model Pool has a new parameter task_slots_per_node
cmdout	[Changelog]   - Model BatchAccountIdentity has a new parameter user_assigned_identities
cmdout	[Changelog] **Breaking changes**
cmdout	[Changelog]   - Model ContainerRegistry no longer has parameter username
cmdout	[Changelog]   - Model ContainerRegistry has a new required parameter user_name
cmdout	[Changelog]   - Model Pool no longer has parameter max_tasks_per_node
warn	Breaking change found in changelog
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from de1388e. 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/batch/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.Batch [View full logs]  [Release SDK Changes]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from de1388e. 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.6351 --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/batch/resource-manager/readme.md
    • cmderr	[resource-manager] node-pre-gyp
cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
cmderr	[resource-manager] WARN template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager] 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"})
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand] 
     Please click here to preview with your @microsoft account.
    Posted by Swagger Pipeline | How to fix these errors?

    This was referenced Jan 22, 2021
    Closed
    Closed
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jan 22, 2021
    Closed
    @dpwatrous
    Copy link
    Member Author

    This fixes a backwards compatibility issue with C# SDK generation here by re-adding these headers which were removed between versions: Azure/azure-sdk-for-net#17962

    Note: I verified that the service does return these headers, so this is also more correct.

    This was referenced Jan 22, 2021
    Closed
    Closed
    @dpwatrous dpwatrous mentioned this pull request Jan 22, 2021
    Merged
    @dpwatrous dpwatrous added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 22, 2021
    @dpwatrous
    Copy link
    Member Author

    dpwatrous commented Jan 22, 2021 •
    edited
    Loading

    Note that no SDKs have been released against this swagger yet. This simply re-adds headers which were accidentally removed between versions.

    @dpwatrous dpwatrous removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 22, 2021
    @ruowan ruowan merged commit de1388e into master Jan 23, 2021
    This was referenced Jan 23, 2021
    Closed
    Closed
    Closed
    Merged
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    This was referenced Jan 23, 2021
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    @dpwatrous @mkarmark
    [Batch] Fix: Readded incorrectly removed Location/Retry-After headers (…
    ecb9775 
    …Azure#12560)

Re-added Location and Retry-After headers to private endpoint connection update operation. Removing these from the swagger was incorrect and caused a breaking change in the C# SDK.
    @JackTn JackTn deleted the dpwatrous/batch-private-endpoint-fix branch August 9, 2021 10:12
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @xingwu1 xingwu1 xingwu1 approved these changes

    @matthchr matthchr Awaiting requested review from matthchr

    Assignees

    @ruowan ruowan

    Labels
    CI-BreakingChange-Python
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @dpwatrous @xingwu1 @ruowan