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.

Sign up for GitHub

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

Jump to bottom

[Hub Generated] Publish private branch 'oravital-dev-security-Microsoft.Security-2022-01-01-preview' #21751

Merged
merged 12 commits into from
Dec 5, 2022
Merged

[Hub Generated] Publish private branch 'oravital-dev-security-Microsoft.Security-2022-01-01-preview' #21751

merged 12 commits into from
Dec 5, 2022

Conversation

oravital7
Copy link
Member

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for 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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.

  • 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

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

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

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

@oravital7
Copy link
Member Author

The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/9724

@openapi-workflow-bot
Copy link

Hi, @oravital7 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 5, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 30 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.2)] new version base version
    governanceAssignments.json 2022-01-01-preview(d107149) 2022-01-01-preview(main)
    governanceRules.json 2022-01-01-preview(d107149) 2022-01-01-preview(main)
    types.json 1.0(d107149) 1.0(main)
    Rule Message
    ❌ 1011 - AddingResponseCode The new version adds a response code '202'.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L368:11
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L49:9
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L49:9
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L91:9
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L91:9
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L131:9
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L131:9
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L180:9
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L180:9
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L341:5
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L341:5
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L972:9
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L634:9
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L207:9
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L207:9
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L252:9
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L252:9
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L295:9
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L295:9
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L347:9
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L347:9
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L619:9
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L435:9
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L774:9
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L539:9
    ❌ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L1248:5
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L865:5
    ❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L390:5
    ❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L429:5
    ❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L662:5
    ❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L819:5
    ❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L870:5
    ❌ 1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'tenantId' in response that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L958:7
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L625:7
    ❌ 1041 - AddedPropertyInResponse The new version has a new property 'excludedScopes' in response that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L958:7
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L625:7
    ❌ 1041 - AddedPropertyInResponse The new version has a new property 'includeMemberScopes' in response that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L958:7
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L625:7
    ❌ 1041 - AddedPropertyInResponse The new version has a new property 'metadata' in response that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L958:7
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L625:7
    ❌ 1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L336:7
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L336:7
    ❌ 1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L712:7
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L476:7
    ❌ 1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L763:7
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L528:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'tenantId' that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L958:7
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L625:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'excludedScopes' that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L958:7
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L625:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'includeMemberScopes' that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L958:7
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L625:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'metadata' that was not found in the old version.
    New: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L958:7
    Old: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L625:7
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️❌LintDiff: 4 Errors, 19 Warnings failed [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-composite-v3 package-composite-v3(d107149) package-composite-v3(main)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    ❌ PathForPutOperation The path for 'put' operation must be under a subscription and resource group.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L429    		 RPC-V2-URI-7,RPC-V2-PUT-1
    ❌ GetOperation200 The get operation should only return 200.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L852    		 RPC-V2-GET-01
    ❌ GetOperation200 The get operation should only return 200.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L897    		 RPC-V2-GET-01
    ❌ GetOperation200 The get operation should only return 200.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L900    		 RPC-V2-GET-01
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get a governance rule by its' ID
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L242
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Delete governance rule
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L337
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L402
    ⚠️ RequiredReadOnlySystemData The response of operation:'managementGroupGovernanceRules_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L430
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L441
    ⚠️ RequiredReadOnlySystemData The response of operation:'ManagementGroupGovernanceRules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L467
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create Governance rule
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L468
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L478
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L524
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Execute governance rule
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L664
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L674
    ⚠️ LroExtension Operations with a 202 response should specify x-ms-long-running-operation: true.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L712
    ⚠️ LroExtension Operations with a 202 response should specify x-ms-long-running-operation: true.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L763
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get governance rules execution status by specific governanceRuleId
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L764
    ⚠️ LroExtension Operations with a 202 response should specify x-ms-long-running-operation: true.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L820
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L831
    ⚠️ LroExtension Operations with a 202 response should specify x-ms-long-running-operation: true.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L871
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L882
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L1048


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ❌ PathForPutOperation The path for 'put' operation must be under a subscription and resource group.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L76
    ❌ GetOperation200 The get operation should only return 200.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L744
    ❌ GetOperation200 The get operation should only return 200.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L801
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L49
    ⚠️ RequiredReadOnlySystemData The response of operation:'GovernanceAssignments_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L80
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L91
    ⚠️ RequiredReadOnlySystemData The response of operation:'GovernanceAssignments_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L120
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L131
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L180
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L261
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L282
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json#L286
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'GovernanceRuleModel'. Consider using the plural form of 'GovernanceRule' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L48
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L49
    ⚠️ RequiredReadOnlySystemData The response of operation:'GovernanceRules_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L77
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L88
    ⚠️ RequiredReadOnlySystemData The response of operation:'GovernanceRules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L114
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L125
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L171
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L207
    ⚠️ RequiredReadOnlySystemData The response of operation:'SecurityConnectorGovernanceRules_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L241
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L252
    ⚠️ RequiredReadOnlySystemData The response of operation:'SecurityConnectorGovernanceRules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L284
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L295
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L347
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L570
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L619
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L723
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L774
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.Security/preview/2022-01-01-preview/governanceRules.json#L977
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/security/resource-manager/readme.md
    tag: specification/security/resource-manager/readme.md#tag-package-composite-v3
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand] 
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand] 
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand] 
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand] 
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand] 
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 5, 2022 •
    edited
    Loading

    Swagger Generation Artifacts

    ️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]

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

    Rule Message
    ️❌SDK Breaking Change Tracking failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-net-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-python-track2 warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-java warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-resource-manager-schemas failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-powershell failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 5, 2022 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/security/armsecurity https://apiview.dev/Assemblies/Review/09b282be3a284584999c1228633ca973
    Java azure-resourcemanager-security https://apiview.dev/Assemblies/Review/9f2389386a9e4da9a4e9fb00fc0d24f0
    JavaScript @azure/arm-security https://apiview.dev/Assemblies/Review/cd8a397855074def95e2176dbc4d9fb3
    Python track2_azure-mgmt-security https://apiview.dev/Assemblies/Review/8475d669917a4e08be80b5d79b2a4b90

    @azure-sdk azure-sdk mentioned this pull request Dec 5, 2022
    Closed
    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-FixRequiredOnFailure NewApiVersionRequired resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 5, 2022
    @openapi-workflow-bot
    Copy link

    Hi @oravital7, 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.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @openapi-workflow-bot
    Copy link

    Hi @oravital7, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
     If you need further help, please feedback via swagger feedback.

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

    @azure-sdk azure-sdk mentioned this pull request Dec 5, 2022
    Closed
    @azure-sdk azure-sdk mentioned this pull request Dec 5, 2022
    Closed
    This was referenced Dec 5, 2022
    Closed
    Closed
    Closed
    @ruowan ruowan added Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 5, 2022
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 5, 2022
    @ruowan ruowan added Approved-LintDiff and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 5, 2022
    @ruowan ruowan merged commit 39e5b4a into main Dec 5, 2022
    @ruowan ruowan deleted the published/Azure/azure-rest-api-specs-pr/oravital-dev-security-Microsoft.Security-2022-01-01-preview branch December 5, 2022 15:29
    This was referenced Dec 5, 2022
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    anandanthony pushed a commit to anandMicro/azure-rest-api-specs that referenced this pull request Dec 16, 2022
    @oravital7 @anandanthony
    [Hub Generated] Publish private branch 'oravital-dev-security-Microso…
    b7c24a0 
    …ft.Security-2022-01-01-preview' (Azure#21751)

* Update governance API docs (At scale)

* Fix model validation

* Fix lint

* Plain english style

* Minor

* Update content

* Renaming

* Comments

* Edit descriptions'

* Adding deletion operation result

* Prettier

* Remove LRO
    kayousef-zz pushed a commit to kayousef-zz/azure-rest-api-specs that referenced this pull request Dec 21, 2022
    @oravital7 @kayousef
    [Hub Generated] Publish private branch 'oravital-dev-security-Microso…
    8349178 
    …ft.Security-2022-01-01-preview' (Azure#21751)

* Update governance API docs (At scale)

* Fix model validation

* Fix lint

* Plain english style

* Minor

* Update content

* Renaming

* Comments

* Edit descriptions'

* Adding deletion operation result

* Prettier

* Remove LRO
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @ruowan ruowan ruowan approved these changes

    Assignees

    @ruowan ruowan

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-LintDiff ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-FixRequiredOnFailure NewApiVersionRequired resource-manager
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @oravital7 @ruowan @AzureRestAPISpecReview