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

Make origin a ProxyResource instead of TrackedResource #10126

Merged
merged 5 commits into from
Jul 17, 2020

Conversation

nachakra
Copy link
Contributor

@nachakra nachakra commented Jul 14, 2020

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

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
  • 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

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 14, 2020

[Staging] Swagger Validation Report

BreakingChange: 33 Errors, 0 Warnings [Detail] [Expand] Only 10 items are listed, please refer to log for more details.
Rule Message
1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.Cdn/stable/2020-03-31/cdn.json#L4426:5
Old: Microsoft.Cdn/stable/2020-03-31/cdn.json#L4426:5
1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.Cdn/stable/2020-03-31/cdn.json#L1304:13
Old: Microsoft.Cdn/stable/2020-03-31/cdn.json#L1304:13
1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.Cdn/stable/2019-12-31/cdn.json#L1290:13
Old: Microsoft.Cdn/stable/2019-12-31/cdn.json#L1290:13
1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.Cdn/stable/2019-12-31/cdn.json#L1304:13
Old: Microsoft.Cdn/stable/2019-12-31/cdn.json#L1304:13
1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.Cdn/stable/2019-12-31/cdn.json#L1310:13
Old: Microsoft.Cdn/stable/2019-12-31/cdn.json#L1310:13
1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.Cdn/stable/2019-12-31/cdn.json#L1316:13
Old: Microsoft.Cdn/stable/2019-12-31/cdn.json#L1316:13
1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.Cdn/stable/2019-12-31/cdn.json#L1384:13
Old: Microsoft.Cdn/stable/2019-12-31/cdn.json#L1384:13
1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.Cdn/stable/2019-12-31/cdn.json#L1390:13
Old: Microsoft.Cdn/stable/2019-12-31/cdn.json#L1390:13
1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.Cdn/stable/2019-12-31/cdn.json#L4330:5
Old: Microsoft.Cdn/stable/2019-12-31/cdn.json#L4330:5
1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.Cdn/stable/2020-04-15/cdn.json#L4450:5
Old: Microsoft.Cdn/stable/2020-04-15/cdn.json#L4450:5
️✔️LintDiff [Detail]
 Validation passes for LintDiff. 
️✔️Avocado [Detail]
 Validation passes for Avocado. 
Posted by Swagger Pipeline | How to fix these errors?

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 14, 2020

Azure CLI Extension Generation - Release

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 Jul 14, 2020

Trenton Generation - Release

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 Jul 14, 2020

azure-sdk-for-go - Release

️✔️ succeeded [Logs] [Expand Details]

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 14, 2020

azure-sdk-for-js - Release

️✔️ succeeded [Logs] [Expand Details]
  • ️✔️ Generate from 0b0aca5 with merge commit 3657725. SDK Automation 13.0.17.20200619.4
  • ️✔️@azure/arm-cdn [View full logs]  [Release 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/cdnManagementClient.js → ./dist/arm-cdn.js...
    [npmPack] created ./dist/arm-cdn.js in 643ms
    [npmPack] npm notice 
    [npmPack] npm notice package: @azure/arm-cdn@4.2.0
    [npmPack] npm notice === Tarball Contents === 
    [npmPack] npm notice 317.1kB dist/arm-cdn.js                                   
    [npmPack] npm notice 115.8kB dist/arm-cdn.min.js                               
    [npmPack] npm notice 5.3kB   esm/cdnManagementClient.js                        
    [npmPack] npm notice 3.0kB   esm/cdnManagementClientContext.js                 
    [npmPack] npm notice 12.5kB  esm/operations/customDomains.js                   
    [npmPack] npm notice 2.9kB   esm/models/customDomainsMappers.js                
    [npmPack] npm notice 2.2kB   esm/operations/edgeNodes.js                       
    [npmPack] npm notice 2.8kB   esm/models/edgeNodesMappers.js                    
    [npmPack] npm notice 25.6kB  esm/operations/endpoints.js                       
    [npmPack] npm notice 2.9kB   esm/models/endpointsMappers.js                    
    [npmPack] npm notice 345B    esm/models/index.js                               
    [npmPack] npm notice 665B    esm/operations/index.js                           
    [npmPack] npm notice 2.4kB   esm/operations/managedRuleSets.js                 
    [npmPack] npm notice 2.8kB   esm/models/managedRuleSetsMappers.js              
    [npmPack] npm notice 127.6kB esm/models/mappers.js                             
    [npmPack] npm notice 2.2kB   esm/operations/operations.js                      
    [npmPack] npm notice 475B    esm/models/operationsMappers.js                   
    [npmPack] npm notice 12.8kB  esm/operations/originGroups.js                    
    [npmPack] npm notice 2.8kB   esm/models/originGroupsMappers.js                 
    [npmPack] npm notice 12.3kB  esm/operations/origins.js                         
    [npmPack] npm notice 2.8kB   esm/models/originsMappers.js                      
    [npmPack] npm notice 3.2kB   esm/models/parameters.js                          
    [npmPack] npm notice 9.6kB   esm/operations/policies.js                        
    [npmPack] npm notice 2.8kB   esm/models/policiesMappers.js                     
    [npmPack] npm notice 15.7kB  esm/operations/profiles.js                        
    [npmPack] npm notice 2.8kB   esm/models/profilesMappers.js                     
    [npmPack] npm notice 2.5kB   esm/operations/resourceUsageOperations.js         
    [npmPack] npm notice 477B    esm/models/resourceUsageOperationsMappers.js      
    [npmPack] npm notice 971B    rollup.config.js                                  
    [npmPack] npm notice 1.6kB   package.json                                      
    [npmPack] npm notice 457B    tsconfig.json                                     
    [npmPack] npm notice 553.5kB dist/arm-cdn.js.map                               
    [npmPack] npm notice 79.0kB  dist/arm-cdn.min.js.map                           
    [npmPack] npm notice 2.1kB   esm/cdnManagementClient.d.ts.map                  
    [npmPack] npm notice 3.3kB   esm/cdnManagementClient.js.map                    
    [npmPack] npm notice 599B    esm/cdnManagementClientContext.d.ts.map           
    [npmPack] npm notice 1.6kB   esm/cdnManagementClientContext.js.map             
    [npmPack] npm notice 3.8kB   esm/operations/customDomains.d.ts.map             
    [npmPack] npm notice 6.1kB   esm/operations/customDomains.js.map               
    [npmPack] npm notice 1.3kB   esm/models/customDomainsMappers.d.ts.map          
    [npmPack] npm notice 1.3kB   esm/models/customDomainsMappers.js.map            
    [npmPack] npm notice 1.0kB   esm/operations/edgeNodes.d.ts.map                 
    [npmPack] npm notice 1.4kB   esm/operations/edgeNodes.js.map                   
    [npmPack] npm notice 1.2kB   esm/models/edgeNodesMappers.d.ts.map              
    [npmPack] npm notice 1.3kB   esm/models/edgeNodesMappers.js.map                
    [npmPack] npm notice 5.7kB   esm/operations/endpoints.d.ts.map                 
    [npmPack] npm notice 11.2kB  esm/operations/endpoints.js.map                   
    [npmPack] npm notice 1.3kB   esm/models/endpointsMappers.d.ts.map              
    [npmPack] npm notice 1.3kB   esm/models/endpointsMappers.js.map                
    [npmPack] npm notice 39.3kB  esm/models/index.d.ts.map                         
    [npmPack] npm notice 334B    esm/operations/index.d.ts.map                     
    [npmPack] npm notice 126B    esm/models/index.js.map                           
    [npmPack] npm notice 349B    esm/operations/index.js.map                       
    [npmPack] npm notice 1.0kB   esm/operations/managedRuleSets.d.ts.map           
    [npmPack] npm notice 1.5kB   esm/operations/managedRuleSets.js.map             
    [npmPack] npm notice 1.3kB   esm/models/managedRuleSetsMappers.d.ts.map        
    [npmPack] npm notice 1.3kB   esm/models/managedRuleSetsMappers.js.map          
    [npmPack] npm notice 5.9kB   esm/models/mappers.d.ts.map                       
    [npmPack] npm notice 68.3kB  esm/models/mappers.js.map                         
    [npmPack] npm notice 1.0kB   esm/operations/operations.d.ts.map                
    [npmPack] npm notice 1.4kB   esm/operations/operations.js.map                  
    [npmPack] npm notice 225B    esm/models/operationsMappers.d.ts.map             
    [npmPack] npm notice 238B    esm/models/operationsMappers.js.map               
    [npmPack] npm notice 3.1kB   esm/operations/originGroups.d.ts.map              
    [npmPack] npm notice 5.6kB   esm/operations/originGroups.js.map                
    [npmPack] npm notice 1.3kB   esm/models/originGroupsMappers.d.ts.map           
    [npmPack] npm notice 1.3kB   esm/models/originGroupsMappers.js.map             
    [npmPack] npm notice 3.1kB   esm/operations/origins.d.ts.map                   
    [npmPack] npm notice 5.6kB   esm/operations/origins.js.map                     
    [npmPack] npm notice 1.2kB   esm/models/originsMappers.d.ts.map                
    [npmPack] npm notice 1.3kB   esm/models/originsMappers.js.map                  
    [npmPack] npm notice 731B    esm/models/parameters.d.ts.map                    
    [npmPack] npm notice 2.4kB   esm/models/parameters.js.map                      
    [npmPack] npm notice 2.6kB   esm/operations/policies.d.ts.map                  
    [npmPack] npm notice 4.8kB   esm/operations/policies.js.map                    
    [npmPack] npm notice 1.3kB   esm/models/policiesMappers.d.ts.map               
    [npmPack] npm notice 1.3kB   esm/models/policiesMappers.js.map                 
    [npmPack] npm notice 4.9kB   esm/operations/profiles.d.ts.map                  
    [npmPack] npm notice 8.2kB   esm/operations/profiles.js.map                    
    [npmPack] npm notice 1.3kB   esm/models/profilesMappers.d.ts.map               
    [npmPack] npm notice 1.3kB   esm/models/profilesMappers.js.map                 
    [npmPack] npm notice 1.1kB   esm/operations/resourceUsageOperations.d.ts.map   
    [npmPack] npm notice 1.5kB   esm/operations/resourceUsageOperations.js.map     
    [npmPack] npm notice 238B    esm/models/resourceUsageOperationsMappers.d.ts.map
    [npmPack] npm notice 251B    esm/models/resourceUsageOperationsMappers.js.map  
    [npmPack] npm notice 3.1kB   README.md                                         
    [npmPack] npm notice 4.6kB   esm/cdnManagementClient.d.ts                      

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 14, 2020

azure-sdk-for-java - Release

️✔️ succeeded [Logs] [Expand Details]

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 14, 2020

azure-sdk-for-net - Release

️✔️ succeeded [Logs] [Expand Details]

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 14, 2020

azure-sdk-for-python - Release

- Breaking Change detected in SDK

⚠️ warning [Logs] [Expand Details]
  • ⚠️ Generate from 0b0aca5 with merge commit 3657725. SDK Automation 13.0.17.20200619.4
  • ⚠️azure-mgmt-cdn [View full logs]  [Release SDK Changes] Breaking Change Detected
    [build_conf] INFO:packaging_tools:Building template azure-mgmt-cdn
    [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-cdn
    [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 19.881% size of original (original: 77969 chars, delta: 15501 chars)
    [ChangeLog] **Features**
    [ChangeLog] 
    [ChangeLog]   - Model Endpoint has a new parameter origin_groups
    [ChangeLog]   - Model Endpoint has a new parameter default_origin_group
    [ChangeLog]   - Model Endpoint has a new parameter url_signing_keys
    [ChangeLog]   - Model EndpointUpdateParameters has a new parameter default_origin_group
    [ChangeLog]   - Model EndpointUpdateParameters has a new parameter url_signing_keys
    [ChangeLog]   - Model Origin has a new parameter private_link_approval_message
    [ChangeLog]   - Model Origin has a new parameter priority
    [ChangeLog]   - Model Origin has a new parameter origin_host_header
    [ChangeLog]   - Model Origin has a new parameter private_link_alias
    [ChangeLog]   - Model Origin has a new parameter private_link_resource_id
    [ChangeLog]   - Model Origin has a new parameter weight
    [ChangeLog]   - Model Origin has a new parameter enabled
    [ChangeLog]   - Model Origin has a new parameter private_endpoint_status
    [ChangeLog]   - Model Origin has a new parameter private_link_location
    [ChangeLog]   - Added operation OriginsOperations.delete
    [ChangeLog]   - Added operation OriginsOperations.create
    [ChangeLog]   - Added operation group OriginGroupsOperations
    [ChangeLog] 
    [ChangeLog] **Breaking changes**
    [ChangeLog] 
    [ChangeLog]   - Model CustomDomain no longer has parameter custom_https_parameters
    [ChangeLog]   - Model Origin no longer has parameter tags
    [ChangeLog]   - Model Origin no longer has parameter location
    [ChangeLog]   - Model OriginUpdateParameters has a new signature
    [ChangeLog]   - Model DeepCreatedOrigin has a new signature

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 14, 2020

azure-sdk-for-python-track2 - Release

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

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@azure-pipelines
Copy link

Azure Pipelines failed to run 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@nachakra
Copy link
Contributor Author

We have not released this API version as yet for public preview. It is scheduled for release next week. So, this is not a breaking change for the users.

@akning-ms
Copy link
Contributor

We have not released this API version as yet for public preview. It is scheduled for release next week. So, this is not a breaking change for the users.
Hi @nachakra, just a confirm, understand it is not released yet, is there any sdk released based on this api version?

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@nachakra
Copy link
Contributor Author

nachakra commented Jul 14, 2020

@akning-ms - Yes we have not released any new versions of SDKs since our 2019-06-15-preview version of the API. So, none of these API versions have any SDK released.

@akning-ms
Copy link
Contributor

Hi @nachakra, Noticed you just have one more commit which also updated 2020-03-01 and 2020-04-15, plus 2019-12-31 totally 3 stable version. so I am confused, are they all not released? if yes, can I know why? :)

@@ -4332,7 +4332,7 @@
"type": "object",
"allOf": [
{
"$ref": "#/definitions/TrackedResource"
"$ref": "#/definitions/ProxyResource"
Copy link
Contributor

Choose a reason for hiding this comment

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

Can I know why have this change from business/service perspective? as it is a breaking change for a stable api version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It should have always been a proxy resource - it is associated with an endpoint which is a tracked resource. We don't need location/tags for this resource. As I said, this API version and the ones following it are not released as yet.

@nachakra
Copy link
Contributor Author

nachakra commented Jul 15, 2020

Hi @nachakra, Noticed you just have one more commit which also updated 2020-03-01 and 2020-04-15, plus 2019-12-31 totally 3 stable version. so I am confused, are they all not released? if yes, can I know why? :)

Because of covid/JEDI related deployment freezes, the 2019-12-31 version slipped quite a bit. 2020-03-01 is in private preview but 2020-04-15 is the version(uber version with 2019-12-31 changes) that we are targeting to release since it is associated with JEDI requirements. So, we will release 2019-12-31 version first with 2020-04-15 releasing in just few weeks after that.

@nachakra
Copy link
Contributor Author

@akning-ms - I addressed your comments. Please take a look and let me know if you still have concerns.

@akning-ms akning-ms added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jul 17, 2020
@mikhailshilkov
Copy link
Contributor

mikhailshilkov commented Aug 20, 2020

Yes we have not released any new versions of SDKs since our 2019-06-15-preview version of the API. So, none of these API versions have any SDK released.

@nachakra Could you elaborate on what "released" means in this context? Does that apply to SDKs only?

Were the API endpoints available for these versions? If yes, this means that changes in specs are breaking for all non-SDK clients?

For instance, location is still mentioned in ARM templates docs here. Was it possible to deploy ARM templates with these versions?

What is the place to track whether these or other spec versions are released or not?

00Kai0 pushed a commit to 00Kai0/azure-rest-api-specs that referenced this pull request Oct 12, 2020
* Make origin a ProxyResource instead of TrackedResource

* Fix model validation error

* Fix model validation errors

* Fix prettier errors

* Make origin a proxyresource for all API versions starting from 12-30-2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants