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

Add Workspace Managed Network Swagger #23283

Conversation

joshharrin
Copy link
Member

@joshharrin joshharrin commented Mar 24, 2023

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-pipeline-app
Copy link

openapi-pipeline-app bot commented Mar 24, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 32 Errors, 13 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
machineLearningServices.json 2023-04-01-preview(592fb30) 2022-10-01(main)
machineLearningServices.json 2023-04-01-preview(592fb30) 2023-02-01-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

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

Rule Message
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L85:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L85:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L126:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L126:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L179:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L179:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L226:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L223:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L329:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L323:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L404:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L398:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L447:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L441:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L729:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L720:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L784:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L775:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L853:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L844:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L913:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L904:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L967:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L958:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1078:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1014:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1132:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1068:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1175:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1111:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1222:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1158:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1266:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1202:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1310:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1246:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1403:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1288:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1448:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1333:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1491:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1376:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1543:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1428:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1588:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1473:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1634:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1519:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1679:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1564:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1721:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1606:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1757:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1642:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1808:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1693:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1850:9
Old: Microsoft.MachineLearningServices/stable/2022-10-01/machineLearningServices.json#L1735:9


The following breaking changes are detected by comparison with the latest preview version:

Rule Message
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'RecurrenceTrigger' removed or renamed?
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L2395:3
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/machineLearningServices.json#L2109:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'CronTrigger' removed or renamed?
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L2395:3
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/machineLearningServices.json#L2109:3
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L5680:9
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/machineLearningServices.json#L5382:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L5684:9
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/machineLearningServices.json#L5386:9
⚠️ 1025 - RequiredStatusChange The 'required' status changed from the old version('True') to the new version('False').
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L5772:7
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L20052:7
⚠️ 1025 - RequiredStatusChange The 'required' status changed from the old version('True') to the new version('False').
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L5801:7
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L13129:7
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L5680:9
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/machineLearningServices.json#L5382:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L5684:9
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/machineLearningServices.json#L5386:9
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'endTime' renamed or removed?
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L5772:7
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L20052:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'triggerType' renamed or removed?
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L5772:7
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L20052:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'endTime' renamed or removed?
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L5801:7
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L13129:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'triggerType' renamed or removed?
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L5801:7
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L13129:7
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L5812:9
Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L13130:9
️❌LintDiff: 4 Errors, 4 Warnings failed [Detail]
compared tags (via openapi-validator v2.0.0) new version base version
package-preview-2023-04 package-preview-2023-04(592fb30) package-preview-2023-04(release-machinelearningservices-Microsoft.MachineLearningServices-2023-04-01-preview)

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

Rule Message Related RPC [For API reviewers]
LongRunningResponseStatusCode A 'delete' operation 'ManagedNetworkSettingsRule_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1987
RPC-Async-V1-01
CreateOperationAsyncResponseValidation An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options'
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L2086
RPC-Async-V1-01
CreateOperationAsyncResponseValidation An async PUT operation must return 201.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L2118
RPC-Async-V1-01
CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L2119
RPC-Async-V1-01
⚠️ 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.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L6411
⚠️ 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.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L6423
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L6488
⚠️ 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.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L6608


The following errors/warnings exist before current PR submission:

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

Rule Message
CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L114
CreateOperationAsyncResponseValidation An async PUT operation must return 201.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L149
CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L156
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L156
DeleteOperationAsyncResponseValidation An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L167
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L200
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L256
PostOperationAsyncResponseValidation An async POST operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L435
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L465
ResourceNameRestriction The resource name parameter 'computeName' should be defined with a 'pattern' restriction.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L762
CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L816
PatchIdentityProperty The patch operation body parameter schema should contains property 'identity'.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L929
PatchSkuProperty The patch operation body parameter schema should contains property 'sku'.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L929
ConsistentPatchProperties The property 'properties.properties' in the request body either not apppear in the resource model or has the wrong level.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L933
LroPatch202 The async patch operation should return 202.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L939
DeleteOperationAsyncResponseValidation An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L954
ResourceNameRestriction The resource name parameter 'computeName' should be defined with a 'pattern' restriction.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1016
ResourceNameRestriction The resource name parameter 'computeName' should be defined with a 'pattern' restriction.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1071
CollectionObjectPropertiesNaming Collection object returned by list operation 'Compute_ListNodes' with 'x-ms-pageable' extension, has no property named 'value'.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1098
ResourceNameRestriction The resource name parameter 'computeName' should be defined with a 'pattern' restriction.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1162
ResourceNameRestriction The resource name parameter 'computeName' should be defined with a 'pattern' restriction.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1208
PostOperationAsyncResponseValidation An async POST operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1209
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1240
ResourceNameRestriction The resource name parameter 'computeName' should be defined with a 'pattern' restriction.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1252
PostOperationAsyncResponseValidation An async POST operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1253
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1284
ResourceNameRestriction The resource name parameter 'computeName' should be defined with a 'pattern' restriction.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1296
PostOperationAsyncResponseValidation An async POST operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1297
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json#L1328
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @joshharrin 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 Mar 24, 2023

    Swagger Generation Artifacts

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

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

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

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

    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

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

    ️❌ azure-sdk-for-go failed [Detail]

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

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

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

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

    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-resource-manager-schemas warning [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 Mar 24, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.MachineLearningServices https://apiview.dev/Assemblies/Review/6e231427a054435e89ca79c0c2c216eb
    Java azure-resourcemanager-machinelearning https://apiview.dev/Assemblies/Review/295e697baa9e4865942c68c3b59d5a78
    .Net Azure.ResourceManager.MachineLearning There is no API change compared with the previous version
    JavaScript @azure/arm-machinelearning https://apiview.dev/Assemblies/Review/987527067fe844f5a1e84053f01ec744

    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview CI-FixRequiredOnFailure resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 24, 2023
    @openapi-workflow-bot
    Copy link

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

    @raosuhas
    Copy link

    @joshharrin Can you please fix the errors introduced by your current PR here : https://github.com/Azure/azure-rest-api-specs/pull/23283/checks?check_run_id=12263002892 for "Swagger LintDiff"

    @raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 24, 2023
    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 24, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Mar 27, 2023
    @openapi-workflow-bot
    Copy link

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

    @joshharrin joshharrin force-pushed the joharrington/add-managed-network-to-04-01-preview branch from 2a34e93 to d5d8e14 Compare March 28, 2023 17:35
    @joshharrin joshharrin force-pushed the joharrington/add-managed-network-to-04-01-preview branch from d5d8e14 to cf504eb Compare March 28, 2023 17:37
    @joshharrin joshharrin removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 28, 2023
    @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 Mar 28, 2023
    @joshharrin
    Copy link
    Member Author

    @raosuhas changes have been made to fix certain validation errors. Remaining Lintdiff errors will not be fixed per discussion within our team. Our service will continue to follow the valid ARM pattern of returning 202 with polling uri in location header for LRO operations same as our other APIs. Please help to approve and merge this PR, I have had teammates review as well. Thanks! cc @seanyao1

    Azure/azure-openapi-validator#483

    @visingla-ms visingla-ms added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 30, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 30, 2023
    @joshharrin
    Copy link
    Member Author

    @visingla-ms @raosuhas . Thank you for your comments and recommendations, all have been addressed. Please help approve, thanks.

    @joshharrin joshharrin removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 30, 2023
    @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 Mar 30, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Mar 30, 2023
    @joshharrin joshharrin force-pushed the joharrington/add-managed-network-to-04-01-preview branch from 1d04c81 to b19cf5a Compare March 30, 2023 02:33
    @AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Mar 30, 2023
    @visingla-ms visingla-ms added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 30, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 30, 2023
    @visingla-ms
    Copy link
    Contributor

    Please see comments: #23283 (comment) and #23283 (comment).

    @joshharrin joshharrin removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 30, 2023
    @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 Mar 30, 2023
    @visingla-ms visingla-ms added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Mar 30, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 30, 2023
    @ArcturusZhang
    Copy link
    Member

    lintdiff errors are either false alarms or not intorduced by this PR

    @ArcturusZhang ArcturusZhang merged commit 72e8f6b into Azure:release-machinelearningservices-Microsoft.MachineLearningServices-2023-04-01-preview Mar 31, 2023
    ArcturusZhang pushed a commit that referenced this pull request Apr 18, 2023
    …023 04 01 preview (#23449)
    
    * Adds base for updating Microsoft.MachineLearningServices from version preview/2023-02-01-preview to version 2023-04-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * [Preview] Bring Back Scheduled Shutdown MLC models (#23040)
    
    * [Preview] Bring Back Scheduled Shutdown MLC models
    
    * update example json
    
    ---------
    
    Co-authored-by: Naman Agarwal <naagarw@microsoft.com>
    
    * add minLength:1 prop to required strings (#23108)
    
    * add parameter enableDataIsolation to workspace properties (#23061)
    
    * add parameter enableDataIsolation to workspace properties
    
    * minor change to re-run the test pipelines
    
    * minor comment change to trigger the test pipeline again
    
    ---------
    
    Co-authored-by: Mingwei He <mingweihe@microsoft.com>
    
    * expose connection expiryTime in 2023-04-01-preview swagger (#23118)
    
    * Add Workspace Managed Network Swagger (#23283)
    
    * add managed network swagger
    
    * fix validation errors
    
    * address ARM comments
    
    * fix example
    
    * do not flatten outbound rules, need nested props
    
    ---------
    
    Co-authored-by: Josh Harrington <joharrington@microsoft.com>
    
    * Add Registries 2023-04-01-Preview Swagger (#23163)
    
    * x
    
    * fix spellcheck
    
    * update preview examples
    
    * update examples
    
    * fix for swagger modelvalidation gate
    
    * examples should be in camelCase
    
    * more fixes for pr gates
    
    * fix syntax
    
    * add registryNameParameter
    
    * addressing comments
    
    * fix one more location property
    
    * address comments
    
    * update PrivateEndpointConnectionProperties
    
    * git didn't push all of my changes
    
    * fix circular dependency
    
    * update
    
    * PATCH operation should have sku, identity properties
    
    ---------
    
    Co-authored-by: Komal Yadav <komalyadav@microsoft.com>
    
    * MFE April-preview 2023 staging (#23165)
    
    * update mfe.json to latest
    
    * update preview examples
    
    * make it pretty
    
    * createOrUpload example touch-ups
    
    * pretty check
    
    * POST pendingUpload lint violation, description, and array
    
    * spell check fixes
    
    * featurestore updates + notification patch updates to align with jobs
    
    * fix feature examples
    
    * rename PendingUpload -> startPendingUpload + better description
    
    * prettier feature get/list.json
    
    * update Job-Update example
    
    * update descriptions
    
    * x-ms-secret-true, remove wasbs and pattern for registries
    
    * update examples to remove wasbsUri
    
    * update registry refrence and add pattern to featuresetname
    
    * temporarily add in registry reference
    
    * one more pattern add-on for featuresetname
    
    * remove wasbs since that is no longer a part of PR
    
    * bump
    
    * add empty secrets to examples - can show object but hide secret itself
    
    * original-uri -> azure-async-operation
    
    * createOrGetPendingUpload -> createOrGetStartPendingUpload
    
    * add ms-secret to uri to keep it from breaking relative to GA
    
    ---------
    
    Co-authored-by: Kayla Ames <kaseager@microsoft.com>
    
    * [HUB] update team configuration related properties (#23285)
    
    * [HUB] update team configuration related properties
    
    * Update description
    
    * fix merge issue
    
    * update workspace get operation example with managenetwork included (#23411)
    
    * custom words merge
    
    * swap to original-uri
    
    * v5->v3
    
    * registryRenames
    
    * mlc update to align with v3 types
    
    * finish updating examples
    
    ---------
    
    Co-authored-by: Naman Agarwal <namanag16@gmail.com>
    Co-authored-by: Naman Agarwal <naagarw@microsoft.com>
    Co-authored-by: Teddy Todorov <thtodoro@microsoft.com>
    Co-authored-by: Ming <hemingwei2017@gmail.com>
    Co-authored-by: Mingwei He <mingweihe@microsoft.com>
    Co-authored-by: jiewe <127981966+jiewe@users.noreply.github.com>
    Co-authored-by: Josh Harrington <53531213+joshharrin@users.noreply.github.com>
    Co-authored-by: Josh Harrington <joharrington@microsoft.com>
    Co-authored-by: Komal Yadav <23komal.yadav23@gmail.com>
    Co-authored-by: Komal Yadav <komalyadav@microsoft.com>
    Co-authored-by: Kayla Ames <kaseager@microsoft.com>
    Co-authored-by: ZhidaLiu <zhili@microsoft.com>
    JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023
    …023 04 01 preview (Azure#23449)
    
    * Adds base for updating Microsoft.MachineLearningServices from version preview/2023-02-01-preview to version 2023-04-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * [Preview] Bring Back Scheduled Shutdown MLC models (Azure#23040)
    
    * [Preview] Bring Back Scheduled Shutdown MLC models
    
    * update example json
    
    ---------
    
    Co-authored-by: Naman Agarwal <naagarw@microsoft.com>
    
    * add minLength:1 prop to required strings (Azure#23108)
    
    * add parameter enableDataIsolation to workspace properties (Azure#23061)
    
    * add parameter enableDataIsolation to workspace properties
    
    * minor change to re-run the test pipelines
    
    * minor comment change to trigger the test pipeline again
    
    ---------
    
    Co-authored-by: Mingwei He <mingweihe@microsoft.com>
    
    * expose connection expiryTime in 2023-04-01-preview swagger (Azure#23118)
    
    * Add Workspace Managed Network Swagger (Azure#23283)
    
    * add managed network swagger
    
    * fix validation errors
    
    * address ARM comments
    
    * fix example
    
    * do not flatten outbound rules, need nested props
    
    ---------
    
    Co-authored-by: Josh Harrington <joharrington@microsoft.com>
    
    * Add Registries 2023-04-01-Preview Swagger (Azure#23163)
    
    * x
    
    * fix spellcheck
    
    * update preview examples
    
    * update examples
    
    * fix for swagger modelvalidation gate
    
    * examples should be in camelCase
    
    * more fixes for pr gates
    
    * fix syntax
    
    * add registryNameParameter
    
    * addressing comments
    
    * fix one more location property
    
    * address comments
    
    * update PrivateEndpointConnectionProperties
    
    * git didn't push all of my changes
    
    * fix circular dependency
    
    * update
    
    * PATCH operation should have sku, identity properties
    
    ---------
    
    Co-authored-by: Komal Yadav <komalyadav@microsoft.com>
    
    * MFE April-preview 2023 staging (Azure#23165)
    
    * update mfe.json to latest
    
    * update preview examples
    
    * make it pretty
    
    * createOrUpload example touch-ups
    
    * pretty check
    
    * POST pendingUpload lint violation, description, and array
    
    * spell check fixes
    
    * featurestore updates + notification patch updates to align with jobs
    
    * fix feature examples
    
    * rename PendingUpload -> startPendingUpload + better description
    
    * prettier feature get/list.json
    
    * update Job-Update example
    
    * update descriptions
    
    * x-ms-secret-true, remove wasbs and pattern for registries
    
    * update examples to remove wasbsUri
    
    * update registry refrence and add pattern to featuresetname
    
    * temporarily add in registry reference
    
    * one more pattern add-on for featuresetname
    
    * remove wasbs since that is no longer a part of PR
    
    * bump
    
    * add empty secrets to examples - can show object but hide secret itself
    
    * original-uri -> azure-async-operation
    
    * createOrGetPendingUpload -> createOrGetStartPendingUpload
    
    * add ms-secret to uri to keep it from breaking relative to GA
    
    ---------
    
    Co-authored-by: Kayla Ames <kaseager@microsoft.com>
    
    * [HUB] update team configuration related properties (Azure#23285)
    
    * [HUB] update team configuration related properties
    
    * Update description
    
    * fix merge issue
    
    * update workspace get operation example with managenetwork included (Azure#23411)
    
    * custom words merge
    
    * swap to original-uri
    
    * v5->v3
    
    * registryRenames
    
    * mlc update to align with v3 types
    
    * finish updating examples
    
    ---------
    
    Co-authored-by: Naman Agarwal <namanag16@gmail.com>
    Co-authored-by: Naman Agarwal <naagarw@microsoft.com>
    Co-authored-by: Teddy Todorov <thtodoro@microsoft.com>
    Co-authored-by: Ming <hemingwei2017@gmail.com>
    Co-authored-by: Mingwei He <mingweihe@microsoft.com>
    Co-authored-by: jiewe <127981966+jiewe@users.noreply.github.com>
    Co-authored-by: Josh Harrington <53531213+joshharrin@users.noreply.github.com>
    Co-authored-by: Josh Harrington <joharrington@microsoft.com>
    Co-authored-by: Komal Yadav <23komal.yadav23@gmail.com>
    Co-authored-by: Komal Yadav <komalyadav@microsoft.com>
    Co-authored-by: Kayla Ames <kaseager@microsoft.com>
    Co-authored-by: ZhidaLiu <zhili@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-LintDiff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-JavaScript CI-FixRequiredOnFailure resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants