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

SourceControl API 2022-01-01-preview version - adding new attribute to SourceControl model #17849

Conversation

debroy
Copy link
Contributor

@debroy debroy commented Feb 14, 2022

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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. - March second week, 2022
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. - March first week, 2022
  4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the 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 refresh required 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

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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a 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, @debroy 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.

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Feb 14, 2022
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 14, 2022

    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:
    Rule Message
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SourceControlModel'. Consider using the plural form of 'SourceControl' 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.SecurityInsights/preview/2022-01-01-preview/SourceControls.json#L48
    ️️✔️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.

    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

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

    @ghost
    Copy link

    ghost commented Feb 14, 2022

    Thank you for your contribution debroy! We will review the pull request and get back to you soon.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 14, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]

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

    ️⚠️SDK Breaking Change Tracking warning [Detail]

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

    ️❌ azure-sdk-for-net 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-go-track2 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 warning [Detail]

    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 warning [Detail]

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

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @debroy, 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 openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 14, 2022
    @openapi-workflow-bot
    Copy link

    Hi, @debroy your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    @dw511214992 dw511214992 merged commit 812ad15 into Azure:dev-Sentinel-2022-01-01-preview Feb 16, 2022
    @dw511214992
    Copy link
    Member

    it doesn't need arm review because it doesn't meet the criterias.

    dw511214992 pushed a commit that referenced this pull request Mar 7, 2022
    * Adds base for updating Microsoft.SecurityInsights from version preview/2021-10-01-preview to version 2022-01-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * SourceControl API 2022-01-01-preview version - adding new attribute to SourceControl model (#17849)
    
    * SourceControl 2022-01-01-preview version change
    
    * fix validation error
    
    * prettified
    
    * prettified
    
    Co-authored-by: debjyoti11 <[email protected]>
    
    * New metadata API (#17942)
    
    * metadata changes
    
    * addressed changes
    
    * updated enum kind
    
    * updated values as well
    
    Co-authored-by: Roey Ben Chaim <[email protected]>
    
    * added new enum to kind (#17994)
    
    Co-authored-by: Roey Ben Chaim <[email protected]>
    
    * Add flag to rotate webhook secret (#17989)
    
    Co-authored-by: debjyoti11 <[email protected]>
    
    * Align definitions with stable version (#17931)
    
    * Align definitions with stable version
    
    * align scheduled rule and template properties with stable
    
    * Note: We are creating a new api-version with this change. Watchlists.json 2022-01-01-preview parameter name changes (#17848)
    
    * changed source to sourceType and watchlistAlias to alias
    
    * Update CreateWatchlistAndWatchlistItems.json
    
    * Update CreateWatchlistItem.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlistItem.json
    
    * Update GetWatchlistByAlias.json
    
    * Update GetWatchlistItemById.json
    
    * Update GetWatchlistItems.json
    
    * Update GetWatchlistByAlias.json
    
    * added missing params to match stable version
    
    * Revert "added missing params to match stable version"
    
    This reverts commit a30a709.
    
    Reverting by 1 commit
    
    * refreshing pipeline
    
    * reverting lint diff change
    
    * attempting to fix RemovedPath breaking changes
    
    * Revert "attempting to fix RemovedPath breaking changes"
    
    This reverts commit 2f96ee3.
    
    reverting attempt at correcting breaking changes. cannot match preview
    to stable without breaking everything.
    
    * adding back source type for backwards compatibility, added response descriptions, corrected PR comments
    
    * adding missing bracket
    
    * ran npm run prettier-fix to correct style issues
    
    * resolving model/definition errors
    
    * Revert "resolving model/definition errors"
    
    This reverts commit fd67a4f.
    
    Reverting prettier changes made to other branches
    
    * Revert "ran npm run prettier-fix to correct style issues"
    
    This reverts commit 3055791.
    
    * update
    
    * Update DeleteWatchlist.json
    
    * Update Watchlists.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * fixing styling issues on Delete example
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * ran npm run prettier on DeleteWatchlist.json
    
    * Update Watchlists.json
    
    * reverting alias to watchlistAlias
    
    Co-authored-by: Hassan Chawiche <[email protected]>
    
    * Rename system to AutoAssigned (#18061)
    
    * Rename system to AutoAssigned
    
    * Add example to list operations
    
    * Update API version in NRT examples
    
    * Execute validation tools and fix results (#17733)
    
    * Execute validation tools and fic results
    
    * Prettyfieir GetIoTById.json
    
    * Watchlists.json-2022-01-01-preview-parameterNameChanges (reverted PR reference for files changed -> https://github.com/Azure/azure-rest-api-specs/pull/17848/files) (#18085)
    
    * changed source to sourceType and watchlistAlias to alias
    
    * Update CreateWatchlistAndWatchlistItems.json
    
    * Update CreateWatchlistItem.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlistItem.json
    
    * Update GetWatchlistByAlias.json
    
    * Update GetWatchlistItemById.json
    
    * Update GetWatchlistItems.json
    
    * Update GetWatchlistByAlias.json
    
    * added missing params to match stable version
    
    * Revert "added missing params to match stable version"
    
    This reverts commit a30a709.
    
    Reverting by 1 commit
    
    * refreshing pipeline
    
    * reverting lint diff change
    
    * attempting to fix RemovedPath breaking changes
    
    * Revert "attempting to fix RemovedPath breaking changes"
    
    This reverts commit 2f96ee3.
    
    reverting attempt at correcting breaking changes. cannot match preview
    to stable without breaking everything.
    
    * adding back source type for backwards compatibility, added response descriptions, corrected PR comments
    
    * adding missing bracket
    
    * ran npm run prettier-fix to correct style issues
    
    * resolving model/definition errors
    
    * Revert "resolving model/definition errors"
    
    This reverts commit fd67a4f.
    
    Reverting prettier changes made to other branches
    
    * Revert "ran npm run prettier-fix to correct style issues"
    
    This reverts commit 3055791.
    
    * update
    
    * Update DeleteWatchlist.json
    
    * Update Watchlists.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * fixing styling issues on Delete example
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * ran npm run prettier on DeleteWatchlist.json
    
    * Update Watchlists.json
    
    * reverting alias to watchlistAlias
    
    * fixing type version
    
    * Update Watchlists.json
    
    * Update DeleteWatchlist.json
    
    * fixing commas
    
    Co-authored-by: Hassan Chawiche <[email protected]>
    Co-authored-by: Usman Hasan <[email protected]>
    
    * Done (#17843)
    
    Co-authored-by: Roy Reinhorn <[email protected]>
    
    * AutomationRules 2022-01-01-preview: Add constraints (#18099)
    
    * add contraints (alinged with the latest stable version)
    
    Co-authored-by: debroy <[email protected]>
    Co-authored-by: debjyoti11 <[email protected]>
    Co-authored-by: RoeyBC <[email protected]>
    Co-authored-by: Roey Ben Chaim <[email protected]>
    Co-authored-by: Laith Hisham <[email protected]>
    Co-authored-by: ushasan <[email protected]>
    Co-authored-by: Hassan Chawiche <[email protected]>
    Co-authored-by: shschwar <[email protected]>
    Co-authored-by: Usman Hasan <[email protected]>
    Co-authored-by: royrein <[email protected]>
    Co-authored-by: Roy Reinhorn <[email protected]>
    Co-authored-by: dosegal <[email protected]>
    Co-authored-by: Arthur Ning <[email protected]>
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request Mar 7, 2022
    * Adds base for updating Microsoft.SecurityInsights from version preview/2021-10-01-preview to version 2022-01-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * SourceControl API 2022-01-01-preview version - adding new attribute to SourceControl model (Azure#17849)
    
    * SourceControl 2022-01-01-preview version change
    
    * fix validation error
    
    * prettified
    
    * prettified
    
    Co-authored-by: debjyoti11 <[email protected]>
    
    * New metadata API (Azure#17942)
    
    * metadata changes
    
    * addressed changes
    
    * updated enum kind
    
    * updated values as well
    
    Co-authored-by: Roey Ben Chaim <[email protected]>
    
    * added new enum to kind (Azure#17994)
    
    Co-authored-by: Roey Ben Chaim <[email protected]>
    
    * Add flag to rotate webhook secret (Azure#17989)
    
    Co-authored-by: debjyoti11 <[email protected]>
    
    * Align definitions with stable version (Azure#17931)
    
    * Align definitions with stable version
    
    * align scheduled rule and template properties with stable
    
    * Note: We are creating a new api-version with this change. Watchlists.json 2022-01-01-preview parameter name changes (Azure#17848)
    
    * changed source to sourceType and watchlistAlias to alias
    
    * Update CreateWatchlistAndWatchlistItems.json
    
    * Update CreateWatchlistItem.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlistItem.json
    
    * Update GetWatchlistByAlias.json
    
    * Update GetWatchlistItemById.json
    
    * Update GetWatchlistItems.json
    
    * Update GetWatchlistByAlias.json
    
    * added missing params to match stable version
    
    * Revert "added missing params to match stable version"
    
    This reverts commit a30a709.
    
    Reverting by 1 commit
    
    * refreshing pipeline
    
    * reverting lint diff change
    
    * attempting to fix RemovedPath breaking changes
    
    * Revert "attempting to fix RemovedPath breaking changes"
    
    This reverts commit 2f96ee3.
    
    reverting attempt at correcting breaking changes. cannot match preview
    to stable without breaking everything.
    
    * adding back source type for backwards compatibility, added response descriptions, corrected PR comments
    
    * adding missing bracket
    
    * ran npm run prettier-fix to correct style issues
    
    * resolving model/definition errors
    
    * Revert "resolving model/definition errors"
    
    This reverts commit fd67a4f.
    
    Reverting prettier changes made to other branches
    
    * Revert "ran npm run prettier-fix to correct style issues"
    
    This reverts commit 3055791.
    
    * update
    
    * Update DeleteWatchlist.json
    
    * Update Watchlists.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * fixing styling issues on Delete example
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * ran npm run prettier on DeleteWatchlist.json
    
    * Update Watchlists.json
    
    * reverting alias to watchlistAlias
    
    Co-authored-by: Hassan Chawiche <[email protected]>
    
    * Rename system to AutoAssigned (Azure#18061)
    
    * Rename system to AutoAssigned
    
    * Add example to list operations
    
    * Update API version in NRT examples
    
    * Execute validation tools and fix results (Azure#17733)
    
    * Execute validation tools and fic results
    
    * Prettyfieir GetIoTById.json
    
    * Watchlists.json-2022-01-01-preview-parameterNameChanges (reverted PR reference for files changed -> https://github.com/Azure/azure-rest-api-specs/pull/17848/files) (Azure#18085)
    
    * changed source to sourceType and watchlistAlias to alias
    
    * Update CreateWatchlistAndWatchlistItems.json
    
    * Update CreateWatchlistItem.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlistItem.json
    
    * Update GetWatchlistByAlias.json
    
    * Update GetWatchlistItemById.json
    
    * Update GetWatchlistItems.json
    
    * Update GetWatchlistByAlias.json
    
    * added missing params to match stable version
    
    * Revert "added missing params to match stable version"
    
    This reverts commit a30a709.
    
    Reverting by 1 commit
    
    * refreshing pipeline
    
    * reverting lint diff change
    
    * attempting to fix RemovedPath breaking changes
    
    * Revert "attempting to fix RemovedPath breaking changes"
    
    This reverts commit 2f96ee3.
    
    reverting attempt at correcting breaking changes. cannot match preview
    to stable without breaking everything.
    
    * adding back source type for backwards compatibility, added response descriptions, corrected PR comments
    
    * adding missing bracket
    
    * ran npm run prettier-fix to correct style issues
    
    * resolving model/definition errors
    
    * Revert "resolving model/definition errors"
    
    This reverts commit fd67a4f.
    
    Reverting prettier changes made to other branches
    
    * Revert "ran npm run prettier-fix to correct style issues"
    
    This reverts commit 3055791.
    
    * update
    
    * Update DeleteWatchlist.json
    
    * Update Watchlists.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * fixing styling issues on Delete example
    
    * Update DeleteWatchlist.json
    
    * Update DeleteWatchlist.json
    
    * ran npm run prettier on DeleteWatchlist.json
    
    * Update Watchlists.json
    
    * reverting alias to watchlistAlias
    
    * fixing type version
    
    * Update Watchlists.json
    
    * Update DeleteWatchlist.json
    
    * fixing commas
    
    Co-authored-by: Hassan Chawiche <[email protected]>
    Co-authored-by: Usman Hasan <[email protected]>
    
    * Done (Azure#17843)
    
    Co-authored-by: Roy Reinhorn <[email protected]>
    
    * AutomationRules 2022-01-01-preview: Add constraints (Azure#18099)
    
    * add contraints (alinged with the latest stable version)
    
    Co-authored-by: debroy <[email protected]>
    Co-authored-by: debjyoti11 <[email protected]>
    Co-authored-by: RoeyBC <[email protected]>
    Co-authored-by: Roey Ben Chaim <[email protected]>
    Co-authored-by: Laith Hisham <[email protected]>
    Co-authored-by: ushasan <[email protected]>
    Co-authored-by: Hassan Chawiche <[email protected]>
    Co-authored-by: shschwar <[email protected]>
    Co-authored-by: Usman Hasan <[email protected]>
    Co-authored-by: royrein <[email protected]>
    Co-authored-by: Roy Reinhorn <[email protected]>
    Co-authored-by: dosegal <[email protected]>
    Co-authored-by: Arthur Ning <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-SdkBreakingChange-JavaScript CI-BreakingChange-Go-V2 CI-BreakingChange-JavaScript customer-reported Issues that are reported by GitHub users external to the Azure organization. WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants