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

Maulik/fix preview #20994

Conversation

Maulik003
Copy link
Contributor

@Maulik003 Maulik003 commented Oct 4, 2022

ARM API Information (Control Plane)

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

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.

@openapi-workflow-bot
Copy link

Hi, @Maulik003 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Oct 4, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️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.
    ️️✔️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.
    ️️✔️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 Oct 4, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

    @erjms erjms self-requested a review October 4, 2022 20:21
    @Maulik003 Maulik003 merged commit 5aef2c3 into dev-machinelearningservices-Microsoft.MachineLearningServices-2022-10-01-preview Oct 4, 2022
    @Maulik003 Maulik003 deleted the maulik/fixPreview branch October 4, 2022 20:23
    weshaggard pushed a commit that referenced this pull request Oct 5, 2022
    …to add version preview/2022-10-01-preview (#20818)
    
    * Adds base for updating Microsoft.MachineLearningServices from version preview/2022-06-01-preview to version 2022-10-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Registries public preview 2022-10-01-preview (#20200)
    
    * Registries public preview 2022-10-01-preview
    
    * Fix validation errors
    
    * Fix LintDiff and Avocado errors
    
    * Fixing prettier errors
    
    * Fixing more LintDiff errors
    
    * Another LintDiff error
    
    * Another Lint error
    
    Co-authored-by: Fahd Kamal <[email protected]>
    
    * Added schedule api (#20273)
    
    * added schedule api
    
    * add updateSchedules to examples parent folder
    
    * fix typo
    
    * change position of allOf
    
    * remove subnet from example compute create
    
    * after prettier run
    
    * Description change for recurrence freq
    
    * point to mfe for common objects
    
    * add hash operator
    
    * removed triggertype as well
    
    * change year
    
    * get rid of breaking changes since we didn't change the api
    
    Co-authored-by: Naman Agarwal <[email protected]>
    
    * Added Compute Instance OS Patching Properties (#20284)
    
    * Added CI Os Patching related properties
    
    * Updated descriptions as per Dennis's suggestions
    
    Co-authored-by: Srivatsa Sinha <[email protected]>
    
    * Maulik/sync preview (#20554)
    
    * Added changes to sync with main
    
    * Fixed Prettier Check
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Remove update schedules REST call for compute instance (#20699)
    
    * change post call to put
    
    * change put to patch
    
    * remove updateschedules rest call
    
    Co-authored-by: Naman Agarwal <[email protected]>
    
    * Update connection type and auth type (#20493)
    
    * Update connection type and auth type
    
    * update connection category
    
    * update x-ms-secret tag
    
    * Add autologger_settings for CI (#20302)
    
    * Add autologger_settings for CI
    
    Add settings to opt-in/out of default mlflow autologger on CIs.
    
    * update machinelearningservices.json
    
    * Add for command job
    
    * fix comma
    
    * Add autologger for command job
    
    * fix CI failures
    
    * Remove mfe.json from PR
    
    * Remove whitespace
    
    * Update custom-words.txt
    
    * Delete incorrect custom-words.txt
    
    * Fixing auto-rest issues in registries (#20772)
    
    * Fixing auto-rest issues in registries
    
    * Removing location from the required list
    
    Co-authored-by: Fahd Kamal <[email protected]>
    
    * Maulik/mfe preview changes (#20372)
    
    * Added mfe.json preview changes
    
    * Added resources to Registries and Workspaces folder
    
    * removed unwanted resources
    
    * removed unwanted resources
    
    * Ran prettier check
    
    * removed unwanted resources
    
    * removed unwanted resources
    
    * Added ManagedOnlineDeployment resource
    
    * Added files to OnlineDeplyment
    
    * Added Model Validation changes
    
    * Added mfe.json changes to handle duplicate operation id changes
    
    * Updated mfe to fix underscore error
    
    * Update title of mfe.json
    
    * Renamed name path parameter
    
    * Updated examples
    
    * Fixed Semantic validations and examples
    
    * Fixed Semantic validations and examples
    
    * Fixed Semantic validations and examples
    
    * Removed name changes from workspaces
    
    * Changes related to Model Validation
    
    * Changes related to Model validation
    
    * Added consumes amd produces in registries.json
    
    * Removed changes from registries
    
    * Updated parameter mlFlowAutologger to mlflowAutologger in mfe.json
    
    * Changed property name to mlflowAutologger
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Updated custom words to resolve merge conflict (#20833)
    
    * Updated custom words to resolve merge conflict
    
    * Updated custom words to resolve merge conflict
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Resolved merge conflict (#20845)
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Fixed LintDiff checks (#20847)
    
    * Fixed LintDiff checks
    
    * Fixed LintDiff checks
    
    * Fixed LintDiff checks
    
    * Fixed LintDiff checks
    
    * Updated examples
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Resolved merge conflict of cutsom-words.txt (#20956)
    
    * Resolved merge conflict
    
    * Resolved merge conflict
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * [Hub Generated] Review request for Microsoft.MachineLearningServices to add version stable/2022-10-01 (#20800) (#20982)
    
    * Adds base for updating Microsoft.MachineLearningServices from version stable/2022-05-01 to version 2022-10-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Added readOnly property (#20506)
    
    * Added readOnly property
    
    * Added changes to sync with main
    
    * Fixed Prettier check
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Add schedule related schemas for Compute Instance (#20697)
    
    * support for update schedules on Compute Instance
    
    * change put to patch
    
    * remove update schedules rest call
    
    Co-authored-by: Naman Agarwal <[email protected]>
    
    * Added mfe.json changes (#20514)
    
    * Added mfe.json changes
    
    * Added checks related changes
    
    * Updated mfe.json to handle online endpoint and deployment changes
    
    * Updated mfe.json with AutoRebuild changes
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Removed duplicate definitions and updated with mfe references (#20840)
    
    * Removed duplicate definitions and updated with mfe references
    
    * Replaced Cron to CronTrigger, Recurrence to RecurrenceTrigger from mfe
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    Co-authored-by: maulikjoshi <[email protected]>
    Co-authored-by: Naman Agarwal <[email protected]>
    Co-authored-by: Naman Agarwal <[email protected]>
    
    Co-authored-by: maulikjoshi <[email protected]>
    Co-authored-by: Naman Agarwal <[email protected]>
    Co-authored-by: Naman Agarwal <[email protected]>
    
    * Revert "[Hub Generated] Review request for Microsoft.MachineLearningS… (#20983)
    
    * Revert "[Hub Generated] Review request for Microsoft.MachineLearningServices to add version stable/2022-10-01 (#20800) (#20982)"
    
    This reverts commit 649ef83.
    
    * Updated readme.md to resolve merge conflict
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Maulik/fix preview (#20994)
    
    * Merged readme from main
    
    * Added preview tag changes
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * shuffle readme tags (#21005)
    
    * conflict resolution (#21007)
    
    Co-authored-by: fahdkmsft <[email protected]>
    Co-authored-by: Fahd Kamal <[email protected]>
    Co-authored-by: Naman Agarwal <[email protected]>
    Co-authored-by: Naman Agarwal <[email protected]>
    Co-authored-by: srivatsasinha <[email protected]>
    Co-authored-by: Srivatsa Sinha <[email protected]>
    Co-authored-by: maulikjoshi <[email protected]>
    Co-authored-by: ZhidaLiu <[email protected]>
    Co-authored-by: prakharg-msft <[email protected]>
    Co-authored-by: Teddy Todorov <[email protected]>
    anandanthony pushed a commit to anandMicro/azure-rest-api-specs that referenced this pull request Dec 16, 2022
    …to add version preview/2022-10-01-preview (Azure#20818)
    
    * Adds base for updating Microsoft.MachineLearningServices from version preview/2022-06-01-preview to version 2022-10-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Registries public preview 2022-10-01-preview (Azure#20200)
    
    * Registries public preview 2022-10-01-preview
    
    * Fix validation errors
    
    * Fix LintDiff and Avocado errors
    
    * Fixing prettier errors
    
    * Fixing more LintDiff errors
    
    * Another LintDiff error
    
    * Another Lint error
    
    Co-authored-by: Fahd Kamal <[email protected]>
    
    * Added schedule api (Azure#20273)
    
    * added schedule api
    
    * add updateSchedules to examples parent folder
    
    * fix typo
    
    * change position of allOf
    
    * remove subnet from example compute create
    
    * after prettier run
    
    * Description change for recurrence freq
    
    * point to mfe for common objects
    
    * add hash operator
    
    * removed triggertype as well
    
    * change year
    
    * get rid of breaking changes since we didn't change the api
    
    Co-authored-by: Naman Agarwal <[email protected]>
    
    * Added Compute Instance OS Patching Properties (Azure#20284)
    
    * Added CI Os Patching related properties
    
    * Updated descriptions as per Dennis's suggestions
    
    Co-authored-by: Srivatsa Sinha <[email protected]>
    
    * Maulik/sync preview (Azure#20554)
    
    * Added changes to sync with main
    
    * Fixed Prettier Check
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Remove update schedules REST call for compute instance (Azure#20699)
    
    * change post call to put
    
    * change put to patch
    
    * remove updateschedules rest call
    
    Co-authored-by: Naman Agarwal <[email protected]>
    
    * Update connection type and auth type (Azure#20493)
    
    * Update connection type and auth type
    
    * update connection category
    
    * update x-ms-secret tag
    
    * Add autologger_settings for CI (Azure#20302)
    
    * Add autologger_settings for CI
    
    Add settings to opt-in/out of default mlflow autologger on CIs.
    
    * update machinelearningservices.json
    
    * Add for command job
    
    * fix comma
    
    * Add autologger for command job
    
    * fix CI failures
    
    * Remove mfe.json from PR
    
    * Remove whitespace
    
    * Update custom-words.txt
    
    * Delete incorrect custom-words.txt
    
    * Fixing auto-rest issues in registries (Azure#20772)
    
    * Fixing auto-rest issues in registries
    
    * Removing location from the required list
    
    Co-authored-by: Fahd Kamal <[email protected]>
    
    * Maulik/mfe preview changes (Azure#20372)
    
    * Added mfe.json preview changes
    
    * Added resources to Registries and Workspaces folder
    
    * removed unwanted resources
    
    * removed unwanted resources
    
    * Ran prettier check
    
    * removed unwanted resources
    
    * removed unwanted resources
    
    * Added ManagedOnlineDeployment resource
    
    * Added files to OnlineDeplyment
    
    * Added Model Validation changes
    
    * Added mfe.json changes to handle duplicate operation id changes
    
    * Updated mfe to fix underscore error
    
    * Update title of mfe.json
    
    * Renamed name path parameter
    
    * Updated examples
    
    * Fixed Semantic validations and examples
    
    * Fixed Semantic validations and examples
    
    * Fixed Semantic validations and examples
    
    * Removed name changes from workspaces
    
    * Changes related to Model Validation
    
    * Changes related to Model validation
    
    * Added consumes amd produces in registries.json
    
    * Removed changes from registries
    
    * Updated parameter mlFlowAutologger to mlflowAutologger in mfe.json
    
    * Changed property name to mlflowAutologger
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Updated custom words to resolve merge conflict (Azure#20833)
    
    * Updated custom words to resolve merge conflict
    
    * Updated custom words to resolve merge conflict
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Resolved merge conflict (Azure#20845)
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Fixed LintDiff checks (Azure#20847)
    
    * Fixed LintDiff checks
    
    * Fixed LintDiff checks
    
    * Fixed LintDiff checks
    
    * Fixed LintDiff checks
    
    * Updated examples
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Resolved merge conflict of cutsom-words.txt (Azure#20956)
    
    * Resolved merge conflict
    
    * Resolved merge conflict
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * [Hub Generated] Review request for Microsoft.MachineLearningServices to add version stable/2022-10-01 (Azure#20800) (Azure#20982)
    
    * Adds base for updating Microsoft.MachineLearningServices from version stable/2022-05-01 to version 2022-10-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Added readOnly property (Azure#20506)
    
    * Added readOnly property
    
    * Added changes to sync with main
    
    * Fixed Prettier check
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Add schedule related schemas for Compute Instance (Azure#20697)
    
    * support for update schedules on Compute Instance
    
    * change put to patch
    
    * remove update schedules rest call
    
    Co-authored-by: Naman Agarwal <[email protected]>
    
    * Added mfe.json changes (Azure#20514)
    
    * Added mfe.json changes
    
    * Added checks related changes
    
    * Updated mfe.json to handle online endpoint and deployment changes
    
    * Updated mfe.json with AutoRebuild changes
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Removed duplicate definitions and updated with mfe references (Azure#20840)
    
    * Removed duplicate definitions and updated with mfe references
    
    * Replaced Cron to CronTrigger, Recurrence to RecurrenceTrigger from mfe
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    Co-authored-by: maulikjoshi <[email protected]>
    Co-authored-by: Naman Agarwal <[email protected]>
    Co-authored-by: Naman Agarwal <[email protected]>
    
    Co-authored-by: maulikjoshi <[email protected]>
    Co-authored-by: Naman Agarwal <[email protected]>
    Co-authored-by: Naman Agarwal <[email protected]>
    
    * Revert "[Hub Generated] Review request for Microsoft.MachineLearningS… (Azure#20983)
    
    * Revert "[Hub Generated] Review request for Microsoft.MachineLearningServices to add version stable/2022-10-01 (Azure#20800) (Azure#20982)"
    
    This reverts commit 649ef83.
    
    * Updated readme.md to resolve merge conflict
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * Maulik/fix preview (Azure#20994)
    
    * Merged readme from main
    
    * Added preview tag changes
    
    Co-authored-by: maulikjoshi <[email protected]>
    
    * shuffle readme tags (Azure#21005)
    
    * conflict resolution (Azure#21007)
    
    Co-authored-by: fahdkmsft <[email protected]>
    Co-authored-by: Fahd Kamal <[email protected]>
    Co-authored-by: Naman Agarwal <[email protected]>
    Co-authored-by: Naman Agarwal <[email protected]>
    Co-authored-by: srivatsasinha <[email protected]>
    Co-authored-by: Srivatsa Sinha <[email protected]>
    Co-authored-by: maulikjoshi <[email protected]>
    Co-authored-by: ZhidaLiu <[email protected]>
    Co-authored-by: prakharg-msft <[email protected]>
    Co-authored-by: Teddy Todorov <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants