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

Adding the TSI GA api-version (2020-05-15) #9974

Merged

Conversation

riserrad
Copy link
Contributor

@riserrad riserrad commented Jun 26, 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

  • 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-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 26, 2020

[Staging] Swagger Validation Report

️✔️BreakingChange [Detail]
 There are no breaking changes. 
️✔️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 Jun 26, 2020

azure-sdk-for-go - Release

️✔️ succeeded [Logs] [Expand Details]

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jun 26, 2020

azure-sdk-for-js - Release

️✔️ succeeded [Logs] [Expand Details]
  • ️✔️ Generate from 631eb6a with merge commit 4d7a442. SDK Automation 13.0.17.20200619.4
  • ️✔️@azure/arm-timeseriesinsights [View full logs]  [Release 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/timeSeriesInsightsClient.js → ./dist/arm-timeseriesinsights.js...
    [npmPack] created ./dist/arm-timeseriesinsights.js in 413ms
    [npmPack] npm notice 
    [npmPack] npm notice package: @azure/[email protected]
    [npmPack] npm notice === Tarball Contents === 
    [npmPack] npm notice 7.1kB   esm/operations/accessPolicies.js            
    [npmPack] npm notice 978B    esm/models/accessPoliciesMappers.js         
    [npmPack] npm notice 115.7kB dist/arm-timeseriesinsights.js              
    [npmPack] npm notice 44.8kB  dist/arm-timeseriesinsights.min.js          
    [npmPack] npm notice 9.8kB   esm/operations/environments.js              
    [npmPack] npm notice 1.4kB   esm/models/environmentsMappers.js           
    [npmPack] npm notice 7.1kB   esm/operations/eventSources.js              
    [npmPack] npm notice 1.4kB   esm/models/eventSourcesMappers.js           
    [npmPack] npm notice 345B    esm/models/index.js                         
    [npmPack] npm notice 516B    esm/operations/index.js                     
    [npmPack] npm notice 49.4kB  esm/models/mappers.js                       
    [npmPack] npm notice 2.3kB   esm/operations/operations.js                
    [npmPack] npm notice 471B    esm/models/operationsMappers.js             
    [npmPack] npm notice 3.9kB   esm/models/parameters.js                    
    [npmPack] npm notice 7.3kB   esm/operations/referenceDataSets.js         
    [npmPack] npm notice 1.4kB   esm/models/referenceDataSetsMappers.js      
    [npmPack] npm notice 1.0kB   rollup.config.js                            
    [npmPack] npm notice 1.8kB   esm/timeSeriesInsightsClient.js             
    [npmPack] npm notice 2.5kB   esm/timeSeriesInsightsClientContext.js      
    [npmPack] npm notice 1.7kB   package.json                                
    [npmPack] npm notice 457B    tsconfig.json                               
    [npmPack] npm notice 3.1kB   esm/operations/accessPolicies.d.ts.map      
    [npmPack] npm notice 4.0kB   esm/operations/accessPolicies.js.map        
    [npmPack] npm notice 484B    esm/models/accessPoliciesMappers.d.ts.map   
    [npmPack] npm notice 497B    esm/models/accessPoliciesMappers.js.map     
    [npmPack] npm notice 250.3kB dist/arm-timeseriesinsights.js.map          
    [npmPack] npm notice 33.8kB  dist/arm-timeseriesinsights.min.js.map      
    [npmPack] npm notice 2.7kB   esm/operations/environments.d.ts.map        
    [npmPack] npm notice 4.7kB   esm/operations/environments.js.map          
    [npmPack] npm notice 646B    esm/models/environmentsMappers.d.ts.map     
    [npmPack] npm notice 659B    esm/models/environmentsMappers.js.map       
    [npmPack] npm notice 3.0kB   esm/operations/eventSources.d.ts.map        
    [npmPack] npm notice 3.9kB   esm/operations/eventSources.js.map          
    [npmPack] npm notice 633B    esm/models/eventSourcesMappers.d.ts.map     
    [npmPack] npm notice 646B    esm/models/eventSourcesMappers.js.map       
    [npmPack] npm notice 17.3kB  esm/models/index.d.ts.map                   
    [npmPack] npm notice 229B    esm/operations/index.d.ts.map               
    [npmPack] npm notice 126B    esm/models/index.js.map                     
    [npmPack] npm notice 244B    esm/operations/index.js.map                 
    [npmPack] npm notice 2.9kB   esm/models/mappers.d.ts.map                 
    [npmPack] npm notice 27.1kB  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 837B    esm/models/parameters.d.ts.map              
    [npmPack] npm notice 2.8kB   esm/models/parameters.js.map                
    [npmPack] npm notice 3.1kB   esm/operations/referenceDataSets.d.ts.map   
    [npmPack] npm notice 4.0kB   esm/operations/referenceDataSets.js.map     
    [npmPack] npm notice 617B    esm/models/referenceDataSetsMappers.d.ts.map
    [npmPack] npm notice 630B    esm/models/referenceDataSetsMappers.js.map  
    [npmPack] npm notice 770B    esm/timeSeriesInsightsClient.d.ts.map       
    [npmPack] npm notice 954B    esm/timeSeriesInsightsClient.js.map         
    [npmPack] npm notice 514B    esm/timeSeriesInsightsClientContext.d.ts.map
    [npmPack] npm notice 1.4kB   esm/timeSeriesInsightsClientContext.js.map  
    [npmPack] npm notice 3.2kB   README.md                                   
    [npmPack] npm notice 10.2kB  esm/operations/accessPolicies.d.ts          
    [npmPack] npm notice 17.0kB  src/operations/accessPolicies.ts            
    [npmPack] npm notice 668B    esm/models/accessPoliciesMappers.d.ts       
    [npmPack] npm notice 980B    src/models/accessPoliciesMappers.ts         
    [npmPack] npm notice 7.9kB   esm/operations/environments.d.ts            
    [npmPack] npm notice 14.7kB  src/operations/environments.ts              
    [npmPack] npm notice 1.1kB   esm/models/environmentsMappers.d.ts         
    [npmPack] npm notice 1.5kB   src/models/environmentsMappers.ts           
    [npmPack] npm notice 10.3kB  esm/operations/eventSources.d.ts            
    [npmPack] npm notice 17.0kB  src/operations/eventSources.ts              
    [npmPack] npm notice 1.1kB   esm/models/eventSourcesMappers.d.ts         
    [npmPack] npm notice 1.4kB   src/models/eventSourcesMappers.ts           
    [npmPack] npm notice 59.2kB  esm/models/index.d.ts                       
    [npmPack] npm notice 200B    esm/operations/index.d.ts                   
    [npmPack] npm notice 56.6kB  src/models/index.ts                         
    [npmPack] npm notice 484B    src/operations/index.ts                     
    [npmPack] npm notice 5.0kB   esm/models/mappers.d.ts                     
    [npmPack] npm notice 41.5kB  src/models/mappers.ts                       
    [npmPack] npm notice 2.1kB   esm/operations/operations.d.ts              
    [npmPack] npm notice 4.2kB   src/operations/operations.ts                
    [npmPack] npm notice 161B    esm/models/operationsMappers.d.ts           
    [npmPack] npm notice 437B    src/models/operationsMappers.ts             
    [npmPack] npm notice 1.0kB   esm/models/parameters.d.ts                  
    [npmPack] npm notice 3.8kB   src/models/parameters.ts                    
    [npmPack] npm notice 10.6kB  esm/operations/referenceDataSets.d.ts       
    [npmPack] npm notice 17.5kB  src/operations/referenceDataSets.ts         
    [npmPack] npm notice 1.0kB   esm/models/referenceDataSetsMappers.d.ts    
    [npmPack] npm notice 1.4kB   src/models/referenceDataSetsMappers.ts      
    [npmPack] npm notice 1.2kB   esm/timeSeriesInsightsClient.d.ts           
    [npmPack] npm notice 1.9kB   src/timeSeriesInsightsClient.ts             
    [npmPack] npm notice 802B    esm/timeSeriesInsightsClientContext.d.ts    

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jun 26, 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 Jun 26, 2020

azure-sdk-for-python - Release

- Breaking Change detected in SDK

⚠️ warning [Logs] [Expand Details]
  • ⚠️ Generate from 631eb6a with merge commit 4d7a442. SDK Automation 13.0.17.20200619.4
  • ⚠️azure-mgmt-timeseriesinsights [View full logs]  [Release SDK Changes] Breaking Change Detected
    [build_conf] INFO:packaging_tools:Building template azure-mgmt-timeseriesinsights
    [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-timeseriesinsights
    [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] warning: no files found matching '*.py' under directory 'tests'
    [build_package] warning: no files found matching '*.yaml' under directory 'tests'
    [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] warning: no files found matching '*.py' under directory 'tests'
    [build_package] warning: no files found matching '*.yaml' under directory 'tests'
    [breaking_change_setup] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
    [ChangeLog] Size of delta 22.923% size of original (original: 37429 chars, delta: 8580 chars)
    [ChangeLog] **Features**
    [ChangeLog] 
    [ChangeLog]   - Model EventHubEventSourceCreateOrUpdateParameters has a new parameter local_timestamp
    [ChangeLog]   - Model IoTHubEventSourceCreateOrUpdateParameters has a new parameter local_timestamp
    [ChangeLog]   - Model EventSourceCreateOrUpdateParameters has a new parameter local_timestamp
    [ChangeLog] 
    [ChangeLog] **Breaking changes**
    [ChangeLog] 
    [ChangeLog]   - Operation EnvironmentsOperations.update has a new signature

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jun 26, 2020

azure-sdk-for-java - 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 Jun 26, 2020

azure-sdk-for-net - 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 Jun 26, 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

"environmentName": "env1",
"parameters": {
"location": "West US",
"kind": "Gen1",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sandshadow I think this would require some code changes, like adding "Gen1" and "Gen2" to the EnvironmentKind enum.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, you're right. We also need to discuss with Blair for his switch to GA api-version in Ibiza.

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@openapi-assignment-bot openapi-assignment-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 28, 2020
@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jun 30, 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

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@riserrad riserrad changed the title First draft of the changes Adding the TSI GA api-version (2020-05-15) Jun 30, 2020
@riserrad
Copy link
Contributor Author

I'm running the Linter to understand if there are issues with the new stable api-version, and I'm getting those:

image

The problem, though, is that it seems to have these required operations already. For example, the Gen1EnvironmentResource must have a get operation. Let's check the facts:

  • Gen1EnvironmentResource inherits #/definitions/EnvironmentResource
  • If we look down to the operations section, we do have a get operation (named Environments_Get) that returns a #/definitions/EnvironmentResource, and has the following response.:
"responses": {
    "200": {
        "description": "The environment definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.",
        "schema": {
            "$ref": "#/definitions/EnvironmentResource"
        }
    },
    "default": {
        "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.",
        "schema": {
            "$ref": "#/definitions/CloudError"
        }
    }
}

The same applies to the other errors:

  • Gen2EnvironmentResource should be covered by the same operation with Id Environments_Get
  • Gen1EnvironmentResource has a patch operation with Id Environments_Update
  • Environments_Update should also cover the PATCH for Gen2EnvironmentResource

Also, if I Lint the preview api-version which this one was derived from (2018-08-15-preview), it does not show any error.

Am I interpreting anything wrong?

@riserrad
Copy link
Contributor Author

This PR should only be merged by the end of next week (July 10th)

@riserrad riserrad marked this pull request as ready for review June 30, 2020 02:15
@ChenTanyi
Copy link
Contributor

I'm running the Linter to understand if there are issues with the new stable api-version, and I'm getting those:

image

The problem, though, is that it seems to have these required operations already. For example, the Gen1EnvironmentResource must have a get operation. Let's check the facts:

  • Gen1EnvironmentResource inherits #/definitions/EnvironmentResource
  • If we look down to the operations section, we do have a get operation (named Environments_Get) that returns a #/definitions/EnvironmentResource, and has the following response.:
"responses": {
    "200": {
        "description": "The environment definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.",
        "schema": {
            "$ref": "#/definitions/EnvironmentResource"
        }
    },
    "default": {
        "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.",
        "schema": {
            "$ref": "#/definitions/CloudError"
        }
    }
}

The same applies to the other errors:

  • Gen2EnvironmentResource should be covered by the same operation with Id Environments_Get
  • Gen1EnvironmentResource has a patch operation with Id Environments_Update
  • Environments_Update should also cover the PATCH for Gen2EnvironmentResource

Also, if I Lint the preview api-version which this one was derived from (2018-08-15-preview), it does not show any error.

Am I interpreting anything wrong?

@jianyexi Could you help to see about the linter issue?

@jianyexi
Copy link
Contributor

jianyexi commented Jun 30, 2020

@riserrad

if I Lint the preview api-version which this one was derived from (2018-08-15-preview), it does not show any error.

The reason is when shipping a new api-version all the lint violation should be fixed .But if you are updating a existing api-version, the old lint violation will be allowed

And I don't know why you defined the resource : Gen2EnvironmentResource , Gen1EnvironmentResource but not use them in any responses or requests , it make no sense.

@sandshadow
Copy link
Contributor

sandshadow commented Jun 30, 2020

And I don't know why you defined the resource : Gen2EnvironmentResource , Gen1EnvironmentResource but not use them in any responses or requests , it make no sense.

Both Gen1EnvironmentResource and Gen2EnvironmentResource inherit from EnvironmentResource. Every operation that returns an EnvironmentResource returns either a Gen1EnvironmentResource or a Gen2EnvironmentResource. So those operations implicitly are using these resources.

Think of EnvironmentResource as an interface with Gen1EnvironmentResource and Gen2EnvironmentResource as the two implementing classes. The kind discriminator on the EnvironmentResource determines which implementation the response actually returns.

If the linters don't recognize this, they need to be revised to handle class hierarchies/interfaces.

@jianyexi
Copy link
Contributor

jianyexi commented Jul 1, 2020

@sandshadow

Got it, thanks for explanation .Since it's an edge case (As I scanned the whole repo , few RP has suppressed these errors by this reason), I think you can suppress the errors the same as before
see,
https://github.com/Azure/azure-rest-api-specs/blob/99c385d95f409ad5a057fc72b80bb329c05d54dd/specification/timeseriesinsights/resource-manager/readme.md#suppression

BTW the suppressing process has changed, you should follow the wiki:
https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process

@riserrad
Copy link
Contributor Author

riserrad commented Jul 6, 2020

Hi @jianyexi - I have submitted a suppression request last wednesday. Do you have any updates about it? We need this spec merged before the end of this week, as we go GA next monday.

If you have any suggestions for us, let us know please.

@jianyexi
Copy link
Contributor

jianyexi commented Jul 7, 2020

Hi @jianyexi - I have submitted a suppression request last wednesday. Do you have any updates about it? We need this spec merged before the end of this week, as we go GA next monday.

If you have any suggestions for us, let us know please.

I will email you later for the next step

@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).

@riserrad
Copy link
Contributor Author

Good morning, folks! A friendly reminder that we would like this PR to be merged today.

@chiragg4u
Copy link
Contributor

For publishing new API version recommendation is to copy the preview version in first commit so that it's easy to review the changes.

@chiragg4u chiragg4u 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 Jul 14, 2020
@riserrad
Copy link
Contributor Author

For publishing new API version recommendation is to copy the preview version in first commit so that it's easy to review the changes.

Thank you for the feedback, @chiragg4u . It's a great point and we will consider it when publishing our new api-version.

@ChenTanyi ChenTanyi merged commit 4d7a442 into Azure:master Jul 15, 2020
fullmetalcloud pushed a commit to fullmetalcloud/azure-rest-api-specs that referenced this pull request Jul 15, 2020
* First draft of the changes

* Minor fixes before publishing the PR

* Adding 2020-05-15 to readme

* Removing examples that are not referenced anywhere

* Adding the suppressions

* Removing EnvironmentsGetExpandStatus.json

* Adding 2020-05-15 in places it was missing in readme.md
00Kai0 pushed a commit to 00Kai0/azure-rest-api-specs that referenced this pull request Oct 12, 2020
* First draft of the changes

* Minor fixes before publishing the PR

* Adding 2020-05-15 to readme

* Removing examples that are not referenced anywhere

* Adding the suppressions

* Removing EnvironmentsGetExpandStatus.json

* Adding 2020-05-15 in places it was missing in readme.md
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants