Skip to content

Conversation

@batrived
Copy link
Contributor

@batrived batrived commented Nov 4, 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
  • 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

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 4, 2020

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail]
There are no breaking changes.
️⚠️~[Staging] LintDiff: 49 Warnings warning [Detail] [Expand] Only 10 items are listed, please refer to log for more details.

Rule Message
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'PartnerRegistrations_CreateOrUpdate' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L3495
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'PartnerRegistrations_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L3562
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L1405
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L1344
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L1781
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L1842
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L1655
⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'listkeys' in:'PartnerNamespaces_ListSharedAccessKeys'. Consider updating the operationId
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L3336
⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'eventSubscriptions' with immediate parent 'PartnerTopic', must have a list by immediate parent operation.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L5654
️️✔️~[Staging] Avocado succeeded [Detail]
Validation passes for Avocado.
️️✔️~[Staging] ModelValidation succeeded [Detail]
Validation passes for ModelValidation.
️️✔️~[Staging] SemanticValidation succeeded [Detail]
Validation passes for SemanticValidation.
️⚠️~[Staging] Cross Version BreakingChange (Base on preview version): 5 Warnings warning [Detail] [Expand]

Rule Message
⚠️ 1011 - AddingResponseCode The new version adds a response code '200'.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L1822:11
⚠️ 1011 - AddingResponseCode The new version adds a response code '200'.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L3142:11
⚠️ 1011 - AddingResponseCode The new version adds a response code '200'.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L4778:11
⚠️ 1011 - AddingResponseCode The new version adds a response code 'default'.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L5517:11
⚠️ 1011 - AddingResponseCode The new version adds a response code '200'.
New: Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json#L1385:11
️️✔️~[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail]
There are no breaking changes.

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 4, 2020

Swagger Generation Artifacts

️️✔️~[Staging] ApiDocPreview succeeded [Detail]
 Please click here to preview with your @microsoft account. 
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @batrived 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.
  • 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. [email protected]

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @openapi-workflow-bot
    Copy link

    Hi, @batrived your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @ChenTanyi

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 4, 2020
    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Nov 4, 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 Nov 4, 2020

    azure-sdk-for-js

    ️✔️ succeeded [Logs] [Expand Details]
    • ️✔️ Generate from 8836e35 with merge commit bef51c965d1bb9ed6da83f1e62afbd5f0212eb30. SDK Automation 13.0.17.20200918.2
    • ️✔️@azure/arm-eventgrid [View full logs]  [Preview SDK Changes]
      Only show 100 items here, please refer to log for details.
      [npmPack] npm WARN deprecated [email protected]: This package has been deprecated and is no longer maintained. Please use @rollup/plugin-node-resolve.
      [npmPack] npm WARN deprecated [email protected]: https://github.com/lydell/resolve-url#deprecated
      [npmPack] npm WARN deprecated [email protected]: 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/eventGridManagementClient.js → ./dist/arm-eventgrid.js...
      [npmPack] created ./dist/arm-eventgrid.js in 497ms
      [npmPack] npm notice 
      [npmPack] npm notice package: @azure/[email protected]
      [npmPack] npm notice === Tarball Contents === 
      [npmPack] npm notice 189.8kB dist/arm-eventgrid.js                                
      [npmPack] npm notice 67.2kB  dist/arm-eventgrid.min.js                            
      [npmPack] npm notice 13.9kB  esm/operations/domains.js                            
      [npmPack] npm notice 1.5kB   esm/models/domainsMappers.js                         
      [npmPack] npm notice 8.2kB   esm/operations/domainTopics.js                       
      [npmPack] npm notice 1.4kB   esm/models/domainTopicsMappers.js                    
      [npmPack] npm notice 2.1kB   esm/eventGridManagementClient.js                     
      [npmPack] npm notice 2.6kB   esm/eventGridManagementClientContext.js              
      [npmPack] npm notice 33.8kB  esm/operations/eventSubscriptions.js                 
      [npmPack] npm notice 1.5kB   esm/models/eventSubscriptionsMappers.js              
      [npmPack] npm notice 263B    esm/models/index.js                                  
      [npmPack] npm notice 535B    esm/operations/index.js                              
      [npmPack] npm notice 53.2kB  esm/models/mappers.js                                
      [npmPack] npm notice 1.5kB   esm/operations/operations.js                         
      [npmPack] npm notice 387B    esm/models/operationsMappers.js                      
      [npmPack] npm notice 4.7kB   esm/models/parameters.js                             
      [npmPack] npm notice 11.0kB  esm/operations/privateEndpointConnections.js         
      [npmPack] npm notice 1.5kB   esm/models/privateEndpointConnectionsMappers.js      
      [npmPack] npm notice 4.2kB   esm/operations/privateLinkResources.js               
      [npmPack] npm notice 402B    esm/models/privateLinkResourcesMappers.js            
      [npmPack] npm notice 907B    rollup.config.js                                     
      [npmPack] npm notice 15.0kB  esm/operations/topics.js                             
      [npmPack] npm notice 1.5kB   esm/models/topicsMappers.js                          
      [npmPack] npm notice 3.0kB   esm/operations/topicTypes.js                         
      [npmPack] npm notice 1.4kB   esm/models/topicTypesMappers.js                      
      [npmPack] npm notice 1.7kB   package.json                                         
      [npmPack] npm notice 457B    tsconfig.json                                        
      [npmPack] npm notice 431.2kB dist/arm-eventgrid.js.map                            
      [npmPack] npm notice 53.8kB  dist/arm-eventgrid.min.js.map                        
      [npmPack] npm notice 4.3kB   esm/operations/domains.d.ts.map                      
      [npmPack] npm notice 7.4kB   esm/operations/domains.js.map                        
      [npmPack] npm notice 739B    esm/models/domainsMappers.d.ts.map                   
      [npmPack] npm notice 752B    esm/models/domainsMappers.js.map                     
      [npmPack] npm notice 2.4kB   esm/operations/domainTopics.d.ts.map                 
      [npmPack] npm notice 4.1kB   esm/operations/domainTopics.js.map                   
      [npmPack] npm notice 710B    esm/models/domainTopicsMappers.d.ts.map              
      [npmPack] npm notice 723B    esm/models/domainTopicsMappers.js.map                
      [npmPack] npm notice 889B    esm/eventGridManagementClient.d.ts.map               
      [npmPack] npm notice 1.2kB   esm/eventGridManagementClient.js.map                 
      [npmPack] npm notice 517B    esm/eventGridManagementClientContext.d.ts.map        
      [npmPack] npm notice 1.4kB   esm/eventGridManagementClientContext.js.map          
      [npmPack] npm notice 10.6kB  esm/operations/eventSubscriptions.d.ts.map           
      [npmPack] npm notice 16.5kB  esm/operations/eventSubscriptions.js.map             
      [npmPack] npm notice 748B    esm/models/eventSubscriptionsMappers.d.ts.map        
      [npmPack] npm notice 761B    esm/models/eventSubscriptionsMappers.js.map          
      [npmPack] npm notice 30.1kB  esm/models/index.d.ts.map                            
      [npmPack] npm notice 292B    esm/operations/index.d.ts.map                        
      [npmPack] npm notice 126B    esm/models/index.js.map                              
      [npmPack] npm notice 306B    esm/operations/index.js.map                          
      [npmPack] npm notice 3.2kB   esm/models/mappers.d.ts.map                          
      [npmPack] npm notice 29.4kB  esm/models/mappers.js.map                            
      [npmPack] npm notice 664B    esm/operations/operations.d.ts.map                   
      [npmPack] npm notice 907B    esm/operations/operations.js.map                     
      [npmPack] npm notice 222B    esm/models/operationsMappers.d.ts.map                
      [npmPack] npm notice 235B    esm/models/operationsMappers.js.map                  
      [npmPack] npm notice 1.2kB   esm/models/parameters.d.ts.map                       
      [npmPack] npm notice 3.7kB   esm/models/parameters.js.map                         
      [npmPack] npm notice 2.8kB   esm/operations/privateEndpointConnections.d.ts.map   
      [npmPack] npm notice 4.6kB   esm/operations/privateEndpointConnections.js.map     
      [npmPack] npm notice 738B    esm/models/privateEndpointConnectionsMappers.d.ts.map
      [npmPack] npm notice 751B    esm/models/privateEndpointConnectionsMappers.js.map  
      [npmPack] npm notice 1.8kB   esm/operations/privateLinkResources.d.ts.map         
      [npmPack] npm notice 2.4kB   esm/operations/privateLinkResources.js.map           
      [npmPack] npm notice 235B    esm/models/privateLinkResourcesMappers.d.ts.map      
      [npmPack] npm notice 248B    esm/models/privateLinkResourcesMappers.js.map        
      [npmPack] npm notice 4.8kB   esm/operations/topics.d.ts.map                       
      [npmPack] npm notice 8.1kB   esm/operations/topics.js.map                         
      [npmPack] npm notice 750B    esm/models/topicsMappers.d.ts.map                    
      [npmPack] npm notice 763B    esm/models/topicsMappers.js.map                      
      [npmPack] npm notice 1.4kB   esm/operations/topicTypes.d.ts.map                   
      [npmPack] npm notice 1.9kB   esm/operations/topicTypes.js.map                     
      [npmPack] npm notice 719B    esm/models/topicTypesMappers.d.ts.map                
      [npmPack] npm notice 732B    esm/models/topicTypesMappers.js.map                  
      [npmPack] npm notice 3.4kB   README.md                                            
      [npmPack] npm notice 12.1kB  esm/operations/domains.d.ts                          
      [npmPack] npm notice 22.8kB  src/operations/domains.ts                            
      [npmPack] npm notice 1.3kB   esm/models/domainsMappers.d.ts                       
      [npmPack] npm notice 1.6kB   src/models/domainsMappers.ts                         
      [npmPack] npm notice 6.6kB   esm/operations/domainTopics.d.ts                     
      [npmPack] npm notice 12.2kB  src/operations/domainTopics.ts                       
      [npmPack] npm notice 1.2kB   esm/models/domainTopicsMappers.d.ts                  
      [npmPack] npm notice 1.5kB   src/models/domainTopicsMappers.ts                    
      [npmPack] npm notice 1.5kB   esm/eventGridManagementClient.d.ts                   
      [npmPack] npm notice 2.2kB   src/eventGridManagementClient.ts                     
      [npmPack] npm notice 936B    esm/eventGridManagementClientContext.d.ts            
      [npmPack] npm notice 2.3kB   src/eventGridManagementClientContext.ts              
      [npmPack] npm notice 43.5kB  esm/operations/eventSubscriptions.d.ts               

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Nov 4, 2020

    azure-sdk-for-go

    ️✔️ succeeded [Logs] [Expand Details]

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Nov 4, 2020

    azure-sdk-for-java

    ⚠️ warning [Logs] [Expand Details]

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Nov 4, 2020

    azure-sdk-for-net

    ️✔️ succeeded [Logs] [Expand Details]

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Nov 4, 2020

    azure-sdk-for-python

    ⚠️ warning [Logs] [Expand Details]
    • ⚠️ Generate from 8836e35 with merge commit bef51c965d1bb9ed6da83f1e62afbd5f0212eb30. SDK 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 Nov 4, 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 Nov 4, 2020

    azure-sdk-for-python-track2

    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 Nov 4, 2020

    azure-resource-manager-schemas

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

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 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).

    @chiragg4u
    Copy link
    Contributor

        "kubernetesBrokerArmId": {
    

    Should this map to extendedLocation to simplify what is the target?


    Refers to: specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json:8358 in 8836e35. [](commit_id = 8836e35, deletion_comment = False)

    @batrived
    Copy link
    Contributor Author

    batrived commented Nov 5, 2020

        "kubernetesBrokerArmId": {
    

    Should this map to extendedLocation to simplify what is the target?

    Refers to: specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-01-preview/EventGrid.json:8358 in 8836e35. [](commit_id = 8836e35, deletion_comment = False)

    We have designed it with 1:N mapping of CustomLocations to KubernetesBroker in mind. Although, customLocation is not needed in Topic when kubernetesBrokerArmId is present but CustomLocations team asked to put it here as well as ARM is going to do some validations based on the customLocation property on the resource.

    @chiragg4u
    Copy link
    Contributor

    We discussed this scenario in the ARM API Review board and with ARC team and here is our recommendation

    1. Microsoft.EventGrid/kubernetesBrokers should map to ARC Cluster Extension, which is being modeled to capture the extension configuration and shows up as an extended location.
    2. This will simplify your Topic/EventSubscription configuration as you don't need extra parameter like kubernetesBrokerArmId, as the extendedLocation property signifies the target for these objects.
      Please note that this model allows multiple extensions can be modeled as part of the custom location, which allow customer to club multiple Azure services into one custom location.
      Gaurav Bhatnagar is the next week oncall and will be sharing more details and provide more guidance.

    @ghost
    Copy link

    ghost commented Dec 22, 2020

    Hi, batrived. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Dec 22, 2020
    @ravbhatnagar ravbhatnagar removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 19, 2021
    @ghost ghost removed the no-recent-activity label Mar 19, 2021
    @ravbhatnagar
    Copy link
    Contributor

    No activity for a long time. please re-add ARM feedback label if you need a review from ARM. removing to reduce noise.

    @ghost
    Copy link

    ghost commented Apr 4, 2021

    Hi, @batrived. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Apr 4, 2021
    @ghost ghost closed this Apr 19, 2021
    @ghost
    Copy link

    ghost commented Apr 19, 2021

    Hi, @batrived. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    This pull request was closed.
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    None yet

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants