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

refactoring EntityQueries - extracting common to EntityDefinitions #14659

Merged
merged 3 commits into from
Jun 10, 2021
Merged

refactoring EntityQueries - extracting common to EntityDefinitions #14659

merged 3 commits into from
Jun 10, 2021

Conversation

ori-licht
Copy link
Contributor

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 - refactor, extracting to common entityDefinitoins
  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
    • 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, @ori-licht 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. [email protected]

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 3, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.

    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.SecurityInsights/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json#L37
    R4037 - MissingTypeObject The schema 'SettingList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L227
    R4037 - MissingTypeObject The schema 'UebaProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L343
    R4037 - MissingTypeObject The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L369
    R4037 - MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: resource-manager/common/1.0/types.json#L52
    R4037 - MissingTypeObject The schema 'ResourceWithEtag' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: resource-manager/common/1.0/types.json#L38
    R4037 - MissingTypeObject The schema 'SentinelOnboardingStatesList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json#L259
    R4037 - MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: resource-manager/common/1.0/types.json#L52
    R4037 - MissingTypeObject The schema 'ResourceWithEtag' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: resource-manager/common/1.0/types.json#L38
    R4037 - MissingTypeObject The schema 'OperationsList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json#L70
    ️️✔️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":"securityinsights/resource-manager/readme.md",
    "tag":"package-2021-03-preview-only",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"securityinsights/resource-manager/readme.md",
    "tag":"package-2021-03-preview-only",
    "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":"securityinsights/resource-manager/readme.md",
    "tag":"package-2021-03-preview-only",
    "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 Jun 3, 2021

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - securityinsight/mgmt/v1.0/securityinsight - v55.1.0
    ️✔️azure-sdk-for-go - securityinsight/mgmt/2020-01-01/securityinsight - v55.1.0
    ️✔️azure-sdk-for-go - preview/securityinsight/mgmt/2019-01-01-preview/securityinsight - v55.1.0
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from ef7ffaa. 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
    • ️✔️securityinsight/mgmt/v1.0/securityinsight [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] This package was removed
    • ️✔️securityinsight/mgmt/2020-01-01/securityinsight [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/securityinsight/mgmt/2019-01-01-preview/securityinsight [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New function `IPGeodataClient.GetPreparer(context.Context, string, string) (*http.Request, error)`
      info	[Changelog] - New function `NewDomainWhoisClientWithBaseURI(string, string) DomainWhoisClient`
      info	[Changelog] - New function `DomainWhoisClient.GetPreparer(context.Context, string, string) (*http.Request, error)`
      info	[Changelog] - New function `DomainWhoisClient.GetSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `NewIPGeodataClientWithBaseURI(string, string) IPGeodataClient`
      info	[Changelog] - New function `IPGeodataClient.Get(context.Context, string, string) (EnrichmentIPGeodata, error)`
      info	[Changelog] - New function `IPGeodataClient.GetSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `IPGeodataClient.GetResponder(*http.Response) (EnrichmentIPGeodata, error)`
      info	[Changelog] - New function `DomainWhoisClient.Get(context.Context, string, string) (EnrichmentDomainWhois, error)`
      info	[Changelog] - New function `NewDomainWhoisClient(string) DomainWhoisClient`
      info	[Changelog] - New function `NewIPGeodataClient(string) IPGeodataClient`
      info	[Changelog] - New function `DomainWhoisClient.GetResponder(*http.Response) (EnrichmentDomainWhois, error)`
      info	[Changelog] - New struct `DomainWhoisClient`
      info	[Changelog] - New struct `EnrichmentDomainWhois`
      info	[Changelog] - New struct `EnrichmentDomainWhoisContact`
      info	[Changelog] - New struct `EnrichmentDomainWhoisContacts`
      info	[Changelog] - New struct `EnrichmentDomainWhoisDetails`
      info	[Changelog] - New struct `EnrichmentDomainWhoisRegistrarDetails`
      info	[Changelog] - New struct `EnrichmentIPGeodata`
      info	[Changelog] - New struct `IPGeodataClient`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 28 additive change(s).
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from ef7ffaa. 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-securityinsight [View full logs]  [Release SDK Changes]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from ef7ffaa. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --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 449ms
    ️️✔️ azure-cli-extensions succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from ef7ffaa. 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/put/Creates or updates an Threat Intelligence Platform 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] --------------------------------------------------------
    • ️✔️securityinsight [View full logs]  [Release Azure CLI Changes]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from ef7ffaa. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      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
    • ️✔️securityinsights [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    asager pushed a commit to asager/azure-rest-api-specs that referenced this pull request Jun 24, 2021
    …zure#14659)
    
    * refactoring EntityQueries - extracting common to EntityDefinitions
    
    * fix bug with reference
    
    * fix reference
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    …zure#14659)
    
    * refactoring EntityQueries - extracting common to EntityDefinitions
    
    * fix bug with reference
    
    * fix reference
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants