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

Fixed the operationId of get/put/delete action #12415

Merged
merged 1 commit into from
Jan 20, 2021
Merged

Fixed the operationId of get/put/delete action #12415

merged 1 commit into from
Jan 20, 2021

Conversation

dosegal
Copy link
Contributor

@dosegal dosegal commented Jan 13, 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 - update existing version to fix an issue in the operation ids of a particular endpoint (out of 4 operations, 3 were defined with incorrect operation id)
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service
  • Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

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

@openapi-workflow-bot
Copy link

Hi, @dosegal Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 13, 2021

    Swagger Validation Report

    ️❌BreakingChange: 6 Errors, 0 Warnings failed [Detail]

    Rule Message
    1008 - ModifiedOperationId The operation id has been changed from 'AlertRules_GetAction' to 'Actions_Get'. This will impact generated code.
    New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L323:7
    Old: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L323:7
    1008 - ModifiedOperationId The operation id has been changed from 'AlertRules_CreateOrUpdateAction' to 'Actions_CreateOrUpdate'. This will impact generated code.
    New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L372:7
    Old: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L372:7
    1008 - ModifiedOperationId The operation id has been changed from 'AlertRules_DeleteAction' to 'Actions_Delete'. This will impact generated code.
    New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L430:7
    Old: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L430:7
    1008 - ModifiedOperationId The operation id has been changed from 'AlertRules_GetAction' to 'Actions_Get'. This will impact generated code.
    New: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L314:7
    Old: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L314:7
    1008 - ModifiedOperationId The operation id has been changed from 'AlertRules_CreateOrUpdateAction' to 'Actions_CreateOrUpdate'. This will impact generated code.
    New: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L360:7
    Old: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L360:7
    1008 - ModifiedOperationId The operation id has been changed from 'AlertRules_DeleteAction' to 'Actions_Delete'. This will impact generated code.
    New: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L415:7
    Old: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L415:7
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 13, 2021

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 39bcc7d. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️securityinsight/mgmt/v1.0/securityinsight [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ## Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `AlertRulesClient.CreateOrUpdateActionSender` has been removed
      info	[Changelog] - Function `AlertRulesClient.DeleteAction` has been removed
      info	[Changelog] - Function `AlertRulesClient.DeleteActionSender` has been removed
      info	[Changelog] - Function `AlertRulesClient.GetAction` has been removed
      info	[Changelog] - Function `AlertRulesClient.CreateOrUpdateActionResponder` has been removed
      info	[Changelog] - Function `AlertRulesClient.GetActionResponder` has been removed
      info	[Changelog] - Function `AlertRulesClient.DeleteActionResponder` has been removed
      info	[Changelog] - Function `AlertRulesClient.CreateOrUpdateAction` has been removed
      info	[Changelog] - Function `AlertRulesClient.GetActionSender` has been removed
      info	[Changelog] - Function `AlertRulesClient.CreateOrUpdateActionPreparer` has been removed
      info	[Changelog] - Function `AlertRulesClient.DeleteActionPreparer` has been removed
      info	[Changelog] - Function `AlertRulesClient.GetActionPreparer` has been removed
      info	[Changelog]
      info	[Changelog] ## New Content
      info	[Changelog]
      info	[Changelog] - New function `ActionsClient.CreateOrUpdateResponder(*http.Response) (ActionResponse, error)`
      info	[Changelog] - New function `ActionsClient.CreateOrUpdatePreparer(context.Context, string, string, string, string, ActionRequest) (*http.Request, error)`
      info	[Changelog] - New function `ActionsClient.Get(context.Context, string, string, string, string) (ActionResponse, error)`
      info	[Changelog] - New function `ActionsClient.GetSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `ActionsClient.CreateOrUpdate(context.Context, string, string, string, string, ActionRequest) (ActionResponse, error)`
      info	[Changelog] - New function `ActionsClient.GetPreparer(context.Context, string, string, string, string) (*http.Request, error)`
      info	[Changelog] - New function `ActionsClient.DeleteSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `ActionsClient.GetResponder(*http.Response) (ActionResponse, error)`
      info	[Changelog] - New function `ActionsClient.DeletePreparer(context.Context, string, string, string, string) (*http.Request, error)`
      info	[Changelog] - New function `ActionsClient.Delete(context.Context, string, string, string, string) (autorest.Response, error)`
      info	[Changelog] - New function `ActionsClient.DeleteResponder(*http.Response) (autorest.Response, error)`
      info	[Changelog] - New function `ActionsClient.CreateOrUpdateSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New struct `OfficeDataConnectorDataTypesTeams`
      info	[Changelog] - New field `Teams` in struct `OfficeDataConnectorDataTypes`
      info	[Changelog]
      info	[Changelog] Total 12 breaking change(s), 15 additive change(s).
      info	[Changelog]
    • ️✔️preview/securityinsight/mgmt/2019-01-01-preview/securityinsight [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 60 items here, please refer to log for details.
      info	[Changelog] - New function `ActionsClient.DeleteSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `EntitiesClient.GetInsightsSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `NewWatchlistItemClientWithBaseURI(string, string) WatchlistItemClient`
      info	[Changelog] - New function `Dynamics365DataConnector.AsOfficeATPDataConnector() (*OfficeATPDataConnector, bool)`
      info	[Changelog] - New function `OfficeATPDataConnector.AsDynamics365DataConnector() (*Dynamics365DataConnector, bool)`
      info	[Changelog] - New function `Dynamics365CheckRequirements.AsAADCheckRequirements() (*AADCheckRequirements, bool)`
      info	[Changelog] - New function `EntitiesClient.GetInsightsPreparer(context.Context, string, string, string, string, EntityGetInsightsParameters) (*http.Request, error)`
      info	[Changelog] - New function `*GetQueriesResponse.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `InsightQueryItem.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `Dynamics365DataConnector.AsMDATPDataConnector() (*MDATPDataConnector, bool)`
      info	[Changelog] - New function `AwsCloudTrailDataConnector.AsDynamics365DataConnector() (*Dynamics365DataConnector, bool)`
      info	[Changelog] - New function `EntitiesClient.GetInsightsResponder(*http.Response) (EntityGetInsightsResponse, error)`
      info	[Changelog] - New function `Dynamics365DataConnector.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `Dynamics365CheckRequirements.AsAwsCloudTrailCheckRequirements() (*AwsCloudTrailCheckRequirements, bool)`
      info	[Changelog] - New function `EntityQuery.AsExpansionEntityQuery() (*ExpansionEntityQuery, bool)`
      info	[Changelog] - New function `AADDataConnector.AsDynamics365DataConnector() (*Dynamics365DataConnector, bool)`
      info	[Changelog] - New function `ActionsClient.Delete(context.Context, string, string, string, string, string) (autorest.Response, error)`
      info	[Changelog] - New struct `Dynamics365CheckRequirements`
      info	[Changelog] - New struct `Dynamics365CheckRequirementsProperties`
      info	[Changelog] - New struct `Dynamics365DataConnector`
      info	[Changelog] - New struct `Dynamics365DataConnectorDataTypes`
      info	[Changelog] - New struct `Dynamics365DataConnectorDataTypesDynamics365CdsActivities`
      info	[Changelog] - New struct `Dynamics365DataConnectorProperties`
      info	[Changelog] - New struct `EntityGetInsightsParameters`
      info	[Changelog] - New struct `EntityGetInsightsResponse`
      info	[Changelog] - New struct `EntityInsightItem`
      info	[Changelog] - New struct `EntityInsightItemQueryTimeInterval`
      info	[Changelog] - New struct `EntityQueryItem`
      info	[Changelog] - New struct `EntityQueryItemProperties`
      info	[Changelog] - New struct `EntityQueryItemPropertiesDataTypesItem`
      info	[Changelog] - New struct `EntityQueryKind1`
      info	[Changelog] - New struct `EntityQueryModel`
      info	[Changelog] - New struct `ExpansionEntityQueriesProperties`
      info	[Changelog] - New struct `ExpansionEntityQuery`
      info	[Changelog] - New struct `GetInsightsError`
      info	[Changelog] - New struct `GetInsightsResultsMetadata`
      info	[Changelog] - New struct `GetQueriesResponse`
      info	[Changelog] - New struct `InsightQueryItem`
      info	[Changelog] - New struct `InsightQueryItemProperties`
      info	[Changelog] - New struct `InsightQueryItemPropertiesAdditionalQuery`
      info	[Changelog] - New struct `InsightQueryItemPropertiesDefaultTimeRange`
      info	[Changelog] - New struct `InsightQueryItemPropertiesReferenceTimeRange`
      info	[Changelog] - New struct `InsightQueryItemPropertiesTableQuery`
      info	[Changelog] - New struct `InsightQueryItemPropertiesTableQueryColumnsDefinitionsItem`
      info	[Changelog] - New struct `InsightQueryItemPropertiesTableQueryQueriesDefinitionsItem`
      info	[Changelog] - New struct `InsightQueryItemPropertiesTableQueryQueriesDefinitionsItemLinkColumnsDefinitionsItem`
      info	[Changelog] - New struct `InsightsTableResult`
      info	[Changelog] - New struct `InsightsTableResultColumnsItem`
      info	[Changelog] - New struct `WatchlistItem`
      info	[Changelog] - New struct `WatchlistItemClient`
      info	[Changelog] - New struct `WatchlistItemProperties`
      info	[Changelog] - New field `LastUpdatedDateUTC` in struct `ScheduledAlertRuleTemplateProperties`
      info	[Changelog] - New field `LastUpdatedDateUTC` in struct `AlertRuleTemplatePropertiesBase`
      info	[Changelog] - New field `LastUpdatedDateUTC` in struct `FusionAlertRuleTemplateProperties`
      info	[Changelog] - New field `LastUpdatedDateUTC` in struct `MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties`
      info	[Changelog] - New field `Etag` in struct `EntityQuery`
      info	[Changelog] - New field `Kind` in struct `EntityQuery`
      info	[Changelog]
      info	[Changelog] Total 24 breaking change(s), 201 additive change(s).
      info	[Changelog]
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 39bcc7d. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/securityinsights/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.SecurityInsights [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 39bcc7d. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --version=3.0.6272 --use=@autorest/python@5.4.3 --python --python-mode=update --multiapi --track2 --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/securityinsights/resource-manager/readme.md
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'AwsCloudTrailDataConnectorDataTypes-logs' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'OfficeDataConnectorDataTypes-exchange' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'OfficeDataConnectorDataTypes-sharePoint' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'OfficeDataConnectorDataTypes-teams' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'TIDataConnectorDataTypes-indicators' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ActionsList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'AlertRuleTemplatesList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'AlertRulesList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'BookmarkList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'CloudError' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'DataConnectorList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'IncidentCommentList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'IncidentList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'OfficeConsentList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Operation' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'OperationsList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ResourceWithEtag' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorResponse' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/CheckDuplicateSchemas): Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
      cmdout	[Autorest] WARNING (PreCheck/PropertyRedeclarationWarning): Schema 'MCASDataConnectorDataTypes' has a property 'alerts' that is already declared the parent schema 'AlertsDataTypeOfDataConnector' but isn't significantly different. The property has been removed from MCASDataConnectorDataTypes
    • ️✔️track2_azure-mgmt-securityinsight [View full logs]  [Release SDK Changes]
      cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-securityinsight
      cmderr	[buildConf] INFO:packaging_tools.conf:Build default conf for azure-mgmt-securityinsight
      cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-securityinsight
      cmderr	[buildPackage] warning: no files found matching '*.py' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.yaml' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.py' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.yaml' under directory 'tests'
      cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
      cmderr	[changelogReport] INFO:__main__:Building code report of azure-mgmt-securityinsight for version None in default folder (False/False/False)
      cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.securityinsight
      cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.securityinsight
      cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.securityinsight
      cmderr	[changelogReport] INFO:__main__:Report written to sdk/securityinsight/azure-mgmt-securityinsight/code_reports/latest/report.json
      cmderr	[changelogReportLatest] INFO:__main__:Building code report of azure-mgmt-securityinsight for version None in default folder (False/False/True)
      cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-securityinsight on PyPI
      cmderr	[changelogReportLatest] INFO:__main__:Got ['1.0.0b1']
      cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
      cmderr	[changelogReportLatest] INFO:__main__:Installing version 1.0.0b1 of azure-mgmt-securityinsight in a venv
      cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
      cmderr	[changelogReportLatest] INFO:__main__:Building code report of azure-mgmt-securityinsight for version 1.0.0b1 in default folder (True/False/False)
      cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.securityinsight
      cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.securityinsight
      cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.securityinsight
      cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/securityinsight/azure-mgmt-securityinsight/code_reports/1.0.0b1/report.json
      cmderr	[changelogReportLatest] INFO:__main__:Writing metadata: {'reports': ['sdk/securityinsight/azure-mgmt-securityinsight/code_reports/1.0.0b1/report.json']}
      warn	Not exact 2 reports found:
      warn	Not generating changelog.
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 39bcc7d. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/securityinsights/resource-manager/readme.md
    • ⚠️azure-mgmt-securityinsight [View full logs]  [Release SDK Changes]
      cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-securityinsight
      cmderr	[buildConf] INFO:packaging_tools.conf:Build default conf for azure-mgmt-securityinsight
      cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-securityinsight
      cmderr	[buildPackage] warning: no files found matching '*.py' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.yaml' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.py' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.yaml' under directory 'tests'
      cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
      cmderr	[changelogReport] Traceback (most recent call last):
      cmderr	[changelogReport]   File "/usr/lib/python3.6/runpy.py", line 193, in _run_module_as_main
      cmderr	[changelogReport]     "__main__", mod_spec)
      cmderr	[changelogReport]   File "/usr/lib/python3.6/runpy.py", line 85, in _run_code
      cmderr	[changelogReport]     exec(code, run_globals)
      cmderr	[changelogReport]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/code_report.py", line 399, in <module>
      cmderr	[changelogReport]     main(args.package_name, args.version, args.no_venv, args.pypi, args.last_pypi, args.output)
      cmderr	[changelogReport]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/code_report.py", line 254, in main
      cmderr	[changelogReport]     path_to_package = resolve_package_directory(package_name)
      cmderr	[changelogReport]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/code_report.py", line 133, in resolve_package_directory
      cmderr	[changelogReport]     return packages[0]
      cmderr	[changelogReport] IndexError: list index out of range
      warn	Script return with result [warning] code [1] signal [null] cwd [azure-sdk-for-python]: python
      cmderr	[changelogReportLatest] Traceback (most recent call last):
      cmderr	[changelogReportLatest]   File "/usr/lib/python3.6/runpy.py", line 193, in _run_module_as_main
      cmderr	[changelogReportLatest]     "__main__", mod_spec)
      cmderr	[changelogReportLatest]   File "/usr/lib/python3.6/runpy.py", line 85, in _run_code
      cmderr	[changelogReportLatest]     exec(code, run_globals)
      cmderr	[changelogReportLatest]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/code_report.py", line 399, in <module>
      cmderr	[changelogReportLatest]     main(args.package_name, args.version, args.no_venv, args.pypi, args.last_pypi, args.output)
      cmderr	[changelogReportLatest]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/code_report.py", line 254, in main
      cmderr	[changelogReportLatest]     path_to_package = resolve_package_directory(package_name)
      cmderr	[changelogReportLatest]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/code_report.py", line 133, in resolve_package_directory
      cmderr	[changelogReportLatest]     return packages[0]
      cmderr	[changelogReportLatest] IndexError: list index out of range
      warn	Script return with result [warning] code [1] signal [null] cwd [azure-sdk-for-python]: python
      warn	Not exact 2 reports found:
      warn	Not generating changelog.
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 39bcc7d. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/securityinsights/resource-manager/readme.md
    • ️✔️@azure/arm-securityinsight [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/securityInsights.js → ./dist/arm-securityinsight.js...
      cmderr	[npmPack] created ./dist/arm-securityinsight.js in 371ms
    ️️✔️ azure-cli-extensions succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 39bcc7d. Azure CLI Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --az --use=@autorest/az@latest --version=3.0.6271 --clear-output-folder=true --azure-cli-extension-folder=/home/vsts/work/1/s/azure-cli-extensions ../azure-rest-api-specs/specification/securityinsights/resource-manager/readme.md
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'AwsCloudTrailDataConnectorDataTypes-logs' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'OfficeDataConnectorDataTypes-exchange' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'OfficeDataConnectorDataTypes-sharePoint' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'OfficeDataConnectorDataTypes-teams' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'TIDataConnectorDataTypes-indicators' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ActionsList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'AlertRuleTemplatesList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'AlertRulesList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'BookmarkList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'CloudError' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'DataConnectorList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'IncidentCommentList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'IncidentList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'OfficeConsentList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Operation' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'OperationsList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ResourceWithEtag' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorResponse' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/CheckDuplicateSchemas): Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
      cmdout	[Autorest] WARNING (PreCheck/PropertyRedeclarationWarning): Schema 'MCASDataConnectorDataTypes' has a property 'alerts' that is already declared the parent schema 'AlertsDataTypeOfDataConnector' but isn't significantly different. The property has been removed from MCASDataConnectorDataTypes
      cmdout	[Autorest] WARNING (): cli.auto-parameter-hidden is not true, skip visibility cleaner
      cmderr	[Autorest] BELOW TEST SCENARIO SECTION CAN BE USED IN readme.cli.md
      cmderr	[Autorest] --------------------------------------------------------
      cmderr	[Autorest]   test-scenario:
      cmderr	[Autorest]     - name: /Actions/put/Creates or updates an action of alert rule.
      cmderr	[Autorest]     - name: /Actions/get/Get all actions of alert rule.
      cmderr	[Autorest]     - name: /Actions/get/Get an action of alert rule.
      cmderr	[Autorest]     - name: /Actions/delete/Delete an action of alert rule.
      cmderr	[Autorest]     - name: /AlertRules/put/Creates or updates a Fusion alert rule.
      cmderr	[Autorest]     - name: /AlertRules/put/Creates or updates a MicrosoftSecurityIncidentCreation rule.
      cmderr	[Autorest]     - name: /AlertRules/put/Creates or updates a Scheduled alert rule.
      cmderr	[Autorest]     - name: /AlertRules/get/Get a Fusion alert rule.
      cmderr	[Autorest]     - name: /AlertRules/get/Get a MicrosoftSecurityIncidentCreation rule.
      cmderr	[Autorest]     - name: /AlertRules/get/Get a Scheduled alert rule.
      cmderr	[Autorest]     - name: /AlertRules/get/Get all alert rules.
      cmderr	[Autorest]     - name: /AlertRules/delete/Delete an alert rule.
      cmderr	[Autorest]     - name: /AlertRuleTemplates/get/Get alert rule template by Id.
      cmderr	[Autorest]     - name: /AlertRuleTemplates/get/Get all alert rule templates.
      cmderr	[Autorest]     - name: /Bookmarks/put/Creates or updates a bookmark.
      cmderr	[Autorest]     - name: /Bookmarks/get/Get a bookmark.
      cmderr	[Autorest]     - name: /Bookmarks/get/Get all bookmarks.
      cmderr	[Autorest]     - name: /Bookmarks/delete/Delete a bookmark.
      cmderr	[Autorest]     - name: /DataConnectors/put/Creates or updates an Office365 data connector.
      cmderr	[Autorest]     - name: /DataConnectors/get/Get a ASC data connector.
      cmderr	[Autorest]     - name: /DataConnectors/get/Get a MCAS data connector.
      cmderr	[Autorest]     - name: /DataConnectors/get/Get a MDATP data connector
      cmderr	[Autorest]     - name: /DataConnectors/get/Get a TI data connector.
      cmderr	[Autorest]     - name: /DataConnectors/get/Get all data connectors.
      cmderr	[Autorest]     - name: /DataConnectors/get/Get an AAD data connector.
      cmderr	[Autorest]     - name: /DataConnectors/get/Get an AATP data connector.
      cmderr	[Autorest]     - name: /DataConnectors/get/Get an AwsCloudTrail data connector.
      cmderr	[Autorest]     - name: /DataConnectors/get/Get an Office365 data connector.
      cmderr	[Autorest]     - name: /DataConnectors/delete/Delete an Office365 data connector.
      cmderr	[Autorest]     - name: /IncidentComments/put/Creates an incident comment.
      cmderr	[Autorest]     - name: /IncidentComments/get/Get all incident comments.
      cmderr	[Autorest]     - name: /IncidentComments/get/Get an incident comment.
      cmderr	[Autorest]     - name: /Incidents/put/Creates or updates an incident.
      cmderr	[Autorest]     - name: /Incidents/get/Get all incidents.
      cmderr	[Autorest]     - name: /Incidents/get/Get an incident.
      cmderr	[Autorest]     - name: /Incidents/delete/Delete an incident.
      cmderr	[Autorest] --------------------------------------------------------
      cmderr	[Autorest] /bin/sh: 1: cd: can't cd to home/vsts/work/1/s/azure-rest-api-specs
      cmderr	[Autorest] fatal: not a git repository (or any of the parent directories): .git
      cmderr	[Autorest] fatal: not a git repository (or any of the parent directories): .git
    • ️✔️securityinsight [View full logs]  [Release Azure CLI Changes]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 39bcc7d. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6351 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/securityinsights/resource-manager/readme.md
    • ️✔️securityinsights [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager]  template-schema-validation-tools@1.0.0 No repository field.
      cmderr	[resource-manager] optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @dosegal
    Copy link
    Contributor Author

    dosegal commented Jan 13, 2021

    @erich-wang I'm aware that chaning the operation id is considered a breaking change because it changes the function name in the SDK, but currently we don't have an officail SDK yet (only preview version).
    The reason for this change is to reduce confusion and consistent naming - The operationId of "get all actions" is Actions_ListByAlertRules, while the operationId of "get/put/delete action" is AlertRules_GetAction/AlertRules_CreateOrUpdateAction/AlertRules_DeleteAction

    @openapi-workflow-bot
    Copy link

    Hi @dosegal, 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.

    @erich-wang
    Copy link
    Member

    @dosegal, I don't have permission to merge this PR as it is marked with breaking change by CI. You still need go thru the process to get exception, thanks.

    Hi @dosegal, 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.

    @mikhailshilkov
    Copy link
    Contributor

    Other tools depend on these Open API specs too, for example, the Pulumi provider. It's currently in preview too, but in my opinion, "we don't have an SDK yet" isn't a great reason for breaking changes in existing APIs.

    @dosegal
    Copy link
    Contributor Author

    dosegal commented Jan 21, 2021

    @mikhailshilkov this is a good point, I agree with you. However, the use of this API is relatively limited and we wanted not to carry this annoying mistake throughout the API lifetime, a mistake that can also confuse the API consumers.
    We also verified that the impact on such tools is relatively small - most of the calls are from a client we generated for our E2E. The rest, much less, are powershell / python scripts.

    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    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 CI-BreakingChange-Go
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants