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

Microsoft.TimeSeriesInsights: Fix swagger correctness issues #14469

Conversation

k-rush
Copy link
Contributor

@k-rush k-rush commented May 19, 2021

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? N/A
  3. When you expect to publish swagger? ASAP
  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
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • 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 Breaking Change 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 or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

@openapi-workflow-bot
Copy link

Hi, @k-rush 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 May 19, 2021

    Swagger Validation Report

    ️❌BreakingChange: 5 Errors, 0 Warnings failed [Detail]
    Rule Message
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'localTimestamp' renamed or removed?
    New: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L2360:7
    Old: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L2263:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'localTimestamp' renamed or removed?
    New: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L2375:7
    Old: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L2278:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'localTimestamp' renamed or removed?
    New: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L2350:7
    Old: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L2249:7
    1041 - AddedPropertyInResponse The new version has a new property 'origin' in response that was not found in the old version.
    New: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L1116:7
    Old: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L1116:7
    1041 - AddedPropertyInResponse The new version has a new property 'properties' in response that was not found in the old version.
    New: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L1116:7
    Old: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L1116:7
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fillGapWithZero
    Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L1215


    The following errors/warnings exist before current PR submission:

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    R4009 - RequiredReadOnlySystemData The response of operation:'Environments_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L140
    R4009 - RequiredReadOnlySystemData The response of operation:'EventSources_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L418
    R4009 - RequiredReadOnlySystemData The response of operation:'ReferenceDataSets_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L665
    R4009 - RequiredReadOnlySystemData The response of operation:'AccessPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L912
    R4009 - RequiredReadOnlySystemData The response of operation:'Environments_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L74
    R4009 - RequiredReadOnlySystemData The response of operation:'EventSources_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L350
    R4009 - RequiredReadOnlySystemData The response of operation:'ReferenceDataSets_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L600
    R4009 - RequiredReadOnlySystemData The response of operation:'AccessPolicies_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L847
    R4009 - RequiredReadOnlySystemData The response of operation:'Environments_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L183
    R4009 - RequiredReadOnlySystemData The response of operation:'EventSources_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L461
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"timeseriesinsights/resource-manager/readme.md",
    "tag":"package-2020-05-15",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"timeseriesinsights/resource-manager/readme.md",
    "tag":"package-2020-05-15",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"timeseriesinsights/resource-manager/readme.md",
    "tag":"package-2020-05-15",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 19, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌[Staging] SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-go - timeseriesinsights/mgmt/2020-05-15/timeseriesinsights - Approved - v55.5.0
    +	Field `CreationTime` of struct `Gen1EnvironmentResourceProperties` has been removed
    +	Field `LocalTimestamp` of struct `EventHubEventSourceMutableProperties` has been removed
    +	Field `LocalTimestamp` of struct `EventSourceMutableProperties` has been removed
    +	Field `LocalTimestamp` of struct `IoTHubEventSourceMutableProperties` has been removed
    +	Field `ProvisioningState` of struct `Gen1EnvironmentResourceProperties` has been removed
    +	Function `EnvironmentsClient.UpdatePreparer` parameter(s) have been changed from `(context.Context, string, string, EnvironmentUpdateParameters)` to `(context.Context, string, string, BasicEnvironmentUpdateParameters)`
    +	Function `EnvironmentsClient.Update` parameter(s) have been changed from `(context.Context, string, string, EnvironmentUpdateParameters)` to `(context.Context, string, string, BasicEnvironmentUpdateParameters)`
    +	Function `EventSourcesClient.UpdatePreparer` parameter(s) have been changed from `(context.Context, string, string, string, EventSourceUpdateParameters)` to `(context.Context, string, string, string, BasicEventSourceUpdateParameters)`
    +	Function `EventSourcesClient.Update` parameter(s) have been changed from `(context.Context, string, string, string, EventSourceUpdateParameters)` to `(context.Context, string, string, string, BasicEventSourceUpdateParameters)`
    ️✔️azure-sdk-for-go - timeseriesinsights/mgmt/2017-11-15/timeseriesinsights - Approved - v55.5.0
    ️✔️azure-sdk-for-go - preview/timeseriesinsights/mgmt/2018-08-15-preview/timeseriesinsights - Approved - v55.5.0
    ️✔️azure-sdk-for-go - preview/timeseriesinsights/mgmt/2017-02-28-preview/timeseriesinsights - Approved - v55.5.0
    azure-sdk-for-python-track2 - track2_azure-mgmt-timeseriesinsights - 1.0.0
    +	Model EventHubEventSourceMutableProperties no longer has parameter local_timestamp
    +	Model EventHubEventSourceUpdateParameters no longer has parameter local_timestamp
    +	Model EventSourceMutableProperties no longer has parameter local_timestamp
    +	Model IoTHubEventSourceMutableProperties no longer has parameter local_timestamp
    +	Model IoTHubEventSourceUpdateParameters no longer has parameter local_timestamp
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 02c10fe. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
      Resource not accessible by integration
      HttpError: Resource not accessible by integration
          at /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@octokit/request@5.6.0/node_modules/@octokit/request/dist-node/index.js:86:21
          at processTicksAndRejections (internal/process/task_queues.js:95:5)
          at async workflowPkgUpdatePR (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:346:21)
          at async Object.exports.workflowPkgMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:41:5)
          at async workflowHandleReadmeMd (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:172:9)
          at async Object.exports.workflowMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:83:9)
          at async Object.exports.sdkAutoMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:152:13)
          at async /home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
    • ️✔️Az.TimeSeriesInsights [View full logs
      error	Fatal error: Resource not accessible by integration
      error	The following packages are still pending:
      error		Az.TimeSeriesInsights
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 02c10fe. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️timeseriesinsights/mgmt/2020-05-15/timeseriesinsights [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 30 items here, please refer to log for details.
      info	[Changelog] - New struct `MetricSpecification`
      info	[Changelog] - New struct `OperationProperties`
      info	[Changelog] - New struct `ServiceSpecification`
      info	[Changelog] - New anonymous field `*IngressStartAtProperties` in struct `EventSourceCommonProperties`
      info	[Changelog] - New field `LocalTimestamp` in struct `EventSourceCommonProperties`
      info	[Changelog] - New field `Kind` in struct `EventHubEventSourceUpdateParameters`
      info	[Changelog] - New anonymous field `*IngressStartAtProperties` in struct `EventHubEventSourceCommonProperties`
      info	[Changelog] - New field `LocalTimestamp` in struct `EventHubEventSourceCommonProperties`
      info	[Changelog] - New anonymous field `*IngressStartAtProperties` in struct `IoTHubEventSourceCommonProperties`
      info	[Changelog] - New field `LocalTimestamp` in struct `IoTHubEventSourceCommonProperties`
      info	[Changelog] - New anonymous field `*IngressStartAtProperties` in struct `AzureEventSourceProperties`
      info	[Changelog] - New field `LocalTimestamp` in struct `AzureEventSourceProperties`
      info	[Changelog] - New anonymous field `*IngressStartAtProperties` in struct `EventHubEventSourceCreationProperties`
      info	[Changelog] - New field `LocalTimestamp` in struct `EventHubEventSourceCreationProperties`
      info	[Changelog] - New field `Kind` in struct `Gen2EnvironmentUpdateParameters`
      info	[Changelog] - New field `Kind` in struct `EnvironmentUpdateParameters`
      info	[Changelog] - New anonymous field `*IngressStartAtProperties` in struct `IoTHubEventSourceResourceProperties`
      info	[Changelog] - New field `LocalTimestamp` in struct `IoTHubEventSourceResourceProperties`
      info	[Changelog] - New field `Kind` in struct `EventSourceUpdateParameters`
      info	[Changelog] - New field `Kind` in struct `Gen1EnvironmentUpdateParameters`
      info	[Changelog] - New anonymous field `*IngressStartAtProperties` in struct `IoTHubEventSourceCreationProperties`
      info	[Changelog] - New field `LocalTimestamp` in struct `IoTHubEventSourceCreationProperties`
      info	[Changelog] - New anonymous field `*IngressStartAtProperties` in struct `EventHubEventSourceResourceProperties`
      info	[Changelog] - New field `LocalTimestamp` in struct `EventHubEventSourceResourceProperties`
      info	[Changelog] - New anonymous field `*OperationProperties` in struct `Operation`
      info	[Changelog] - New field `Origin` in struct `Operation`
      info	[Changelog] - New field `Kind` in struct `IoTHubEventSourceUpdateParameters`
      info	[Changelog]
      info	[Changelog] Total 8 breaking change(s), 72 additive change(s).
      info	[Changelog]
    • ️✔️timeseriesinsights/mgmt/2017-11-15/timeseriesinsights [View full logs
      info	[Changelog] No exported changes
    • ️✔️preview/timeseriesinsights/mgmt/2018-08-15-preview/timeseriesinsights [View full logs
      info	[Changelog] No exported changes
    • ️✔️preview/timeseriesinsights/mgmt/2017-02-28-preview/timeseriesinsights [View full logs
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 02c10fe. 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.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/timeseriesinsights/resource-manager/readme.md
    • ️✔️@azure/arm-timeseriesinsights [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/timeSeriesInsightsClient.js → ./dist/arm-timeseriesinsights.js...
      cmderr	[npmPack] created ./dist/arm-timeseriesinsights.js in 398ms
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 02c10fe. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️track2_azure-mgmt-timeseriesinsights [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model EventSourceCommonProperties has a new parameter local_timestamp
      info	[Changelog]   - Model EventSourceCommonProperties has a new parameter type
      info	[Changelog]   - Model EventSourceCommonProperties has a new parameter time
      info	[Changelog]   - Model EventHubEventSourceCreateOrUpdateParameters has a new parameter type
      info	[Changelog]   - Model EventHubEventSourceCreateOrUpdateParameters has a new parameter local_timestamp_properties_local_timestamp
      info	[Changelog]   - Model EventHubEventSourceCreateOrUpdateParameters has a new parameter time
      info	[Changelog]   - Model Operation has a new parameter origin
      info	[Changelog]   - Model Operation has a new parameter service_specification
      info	[Changelog]   - Model IoTHubEventSourceCommonProperties has a new parameter local_timestamp
      info	[Changelog]   - Model IoTHubEventSourceCommonProperties has a new parameter type
      info	[Changelog]   - Model IoTHubEventSourceCommonProperties has a new parameter time
      info	[Changelog]   - Model EventHubEventSourceCreationProperties has a new parameter local_timestamp
      info	[Changelog]   - Model EventHubEventSourceCreationProperties has a new parameter type
      info	[Changelog]   - Model EventHubEventSourceCreationProperties has a new parameter time
      info	[Changelog]   - Model AzureEventSourceProperties has a new parameter local_timestamp
      info	[Changelog]   - Model AzureEventSourceProperties has a new parameter type
      info	[Changelog]   - Model AzureEventSourceProperties has a new parameter time
      info	[Changelog]   - Model IoTHubEventSourceCreateOrUpdateParameters has a new parameter type
      info	[Changelog]   - Model IoTHubEventSourceCreateOrUpdateParameters has a new parameter local_timestamp_properties_local_timestamp
      info	[Changelog]   - Model IoTHubEventSourceCreateOrUpdateParameters has a new parameter time
      info	[Changelog]   - Model EventHubEventSourceCommonProperties has a new parameter local_timestamp
      info	[Changelog]   - Model EventHubEventSourceCommonProperties has a new parameter type
      info	[Changelog]   - Model EventHubEventSourceCommonProperties has a new parameter time
      info	[Changelog]   - Model EventHubEventSourceResource has a new parameter local_timestamp
      info	[Changelog]   - Model EventHubEventSourceResource has a new parameter type_properties_ingress_start_at_type
      info	[Changelog]   - Model EventHubEventSourceResource has a new parameter time
      info	[Changelog]   - Model IoTHubEventSourceCreationProperties has a new parameter local_timestamp
      info	[Changelog]   - Model IoTHubEventSourceCreationProperties has a new parameter type
      info	[Changelog]   - Model IoTHubEventSourceCreationProperties has a new parameter time
      info	[Changelog]   - Model EventHubEventSourceResourceProperties has a new parameter local_timestamp
      info	[Changelog]   - Model EventHubEventSourceResourceProperties has a new parameter type
      info	[Changelog]   - Model EventHubEventSourceResourceProperties has a new parameter time
      info	[Changelog]   - Model IoTHubEventSourceResourceProperties has a new parameter local_timestamp
      info	[Changelog]   - Model IoTHubEventSourceResourceProperties has a new parameter type
      info	[Changelog]   - Model IoTHubEventSourceResourceProperties has a new parameter time
      info	[Changelog]   - Model IoTHubEventSourceResource has a new parameter local_timestamp
      info	[Changelog]   - Model IoTHubEventSourceResource has a new parameter type_properties_ingress_start_at_type
      info	[Changelog]   - Model IoTHubEventSourceResource has a new parameter time
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Parameter kind of model EventHubEventSourceUpdateParameters is now required
      info	[Changelog]   - Parameter kind of model IoTHubEventSourceUpdateParameters is now required
      info	[Changelog]   - Parameter kind of model EventSourceUpdateParameters is now required
      info	[Changelog]   - Parameter kind of model Gen1EnvironmentUpdateParameters is now required
      info	[Changelog]   - Parameter kind of model Gen2EnvironmentUpdateParameters is now required
      info	[Changelog]   - Parameter kind of model EnvironmentUpdateParameters is now required
      info	[Changelog]   - Model EventHubEventSourceUpdateParameters no longer has parameter local_timestamp
      info	[Changelog]   - Model IoTHubEventSourceUpdateParameters no longer has parameter local_timestamp
      info	[Changelog]   - Model EventHubEventSourceMutableProperties no longer has parameter local_timestamp
      info	[Changelog]   - Model IoTHubEventSourceMutableProperties no longer has parameter local_timestamp
      info	[Changelog]   - Model EventSourceMutableProperties no longer has parameter local_timestamp
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 02c10fe. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    • ️✔️timeseriesinsights [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @k-rush k-rush changed the title Fix swagger correctness issues Microsoft.TimeSeriesinsights: Fix swagger correctness issues May 19, 2021
    @k-rush k-rush changed the title Microsoft.TimeSeriesinsights: Fix swagger correctness issues Microsoft.TimeSeriesInsights: Fix swagger correctness issues May 19, 2021
    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @openapi-workflow-bot
    Copy link

    Hi @k-rush, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @k-rush
    Copy link
    Contributor Author

    k-rush commented May 19, 2021

    @akning-ms I believe 3 of the breaking changes are a false positive. While the tooling mentions I removed the localTimeStamp property, I simply moved it to be included in request body for PUT/PATCH for EventSources, as well as the GET/PUT/PATCH response body. This is to fix part of this relevant S360 KPI: https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=1F5C742A-8D4D-4F55-B2EB-9124B8B3C874

    The other 2 are additional properties on the Operations response. This is required to fix the following Swagger Correctness S360 KPI: https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=61AD52F9-7FD8-4B91-84EF-38672D8D5B3D

    I don't think either of these will have measurable negative customer impact, but I'm open to suggestions on how to mitigate any if there were to be.

    @akning-ms akning-ms assigned ruowan and unassigned akning-ms May 20, 2021
    @akning-ms
    Copy link
    Contributor

    Yes. looks localTimeStamp is false alarm. @jianyexi to confirm,
    But for adding property to fix S360 issue. it require breaking change review approval. step is:
    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.

    Copy link
    Contributor

    @riserrad riserrad left a comment

    Choose a reason for hiding this comment

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

    Changes look good to me.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label May 27, 2021
    @k-rush k-rush added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 7, 2021
    @k-rush
    Copy link
    Contributor Author

    k-rush commented Jun 7, 2021

    @ruowan, can you please review this?

    @ruowan
    Copy link
    Member

    ruowan commented Jun 8, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @ruowan
    Copy link
    Member

    ruowan commented Jun 8, 2021

    Python SDK track2 failed. @msyyc help to take a look.

    @RAY-316
    Copy link
    Contributor

    RAY-316 commented Jun 9, 2021

    @k-rush I've made some changes to your branch to fix Python SDK track2 failed, you can use it as a reference.

    @k-rush
    Copy link
    Contributor Author

    k-rush commented Jun 17, 2021

    @RAY-316 Thanks! Those changes were already made in master - the merge I just did should have fixed the issue

    @k-rush
    Copy link
    Contributor Author

    k-rush commented Jul 1, 2021

    @ruowan what else do I need to do to get this PR in?

    @zhenglaizhang
    Copy link
    Contributor

    @ruowan what else do I need to do to get this PR in?

    @msyyc @ArcturusZhang pls help check the python & go SDK breaking changes.

    @ArcturusZhang ArcturusZhang added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Jul 2, 2021
    @msyyc
    Copy link
    Member

    msyyc commented Jul 2, 2021

    For python, the breaking change is permitted.

    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 Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go CI-BreakingChange-Go CI-BreakingChange-Python FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    9 participants