Updating Swagger Spec for MLC for CustomServices#19781
Merged
ArcturusZhang merged 12 commits intoAzure:dev-machinelearningservices-Microsoft.MachineLearningServices-2022-06-01-previewfrom Jul 25, 2022
Conversation
|
Hi, @srivatsasinha Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| machineLearningServices.json | 2022-06-01(ad693e9) | 2022-05-01(main) |
| machineLearningServices.json | 2022-06-01(ad693e9) | 2022-02-01(main) |
The following breaking changes are detected by comparison with the latest preview version:
️⚠️LintDiff: 13 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-06 | package-preview-2022-06(ad693e9) | package-preview-2022-06(dev-machinelearningservices-Microsoft.MachineLearningServices-2022-06-01-preview) |
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' 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.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1010 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: privileged Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L4913 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: readOnly Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L4980 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nocopy Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L5018 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: createHostPath Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L5033 |
|
| 'Image' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L4863 |
|
| 'EnvironmentVariable' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L4887 |
|
| 'Docker' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L4910 |
|
| 'Endpoint' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L4921 |
|
| 'VolumeDefinition' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L4961 |
|
| 'VolumeOptions' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L5015 |
|
| 'BindOptions' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L5025 |
|
| 'TmpfsOptions' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L5045 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Collection object 'AmlComputeNodesInformation' returned by list operation 'Compute_ListNodes' with 'x-ms-pageable' extension, has no property named 'value'. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1086 |
| Since operation 'QuotasUpdate' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L567 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3248 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3349 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3444 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3657 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3846 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3867 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3935 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3978 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3998 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L4013 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L4283 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L5827 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L6007 |
|
| Based on the response model schema, operation 'VirtualMachineSizes_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L519 |
|
| Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1565 |
|
| Based on the response model schema, operation 'Workspaces_ListOutboundNetworkDependenciesEndpoints' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1927 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' 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.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L713 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' 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.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L759 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' 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.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L812 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' 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.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L893 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' 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.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L947 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' 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.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1064 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' 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.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1156 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' 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.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1202 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' 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.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1246 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' 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.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1290 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' 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.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1333 |
|
| OperationId should contain the verb: 'updatequotas' in:'Quotas_Update'. Consider updating the operationId Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L567 |
️️✔️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: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/ad693e9238fd56bb65d9a779d5f6d4338f9a2069/specification/machinelearningservices/resource-manager/readme.md#tag-package-preview-2022-06">machinelearningservices/resource-manager/readme.md#package-preview-2022-06
| Rule | Message |
|---|---|
| "readme":"machinelearningservices/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
srivatsasinha
changed the title
teochaban
reviewed
Jul 15, 2022
| "MachineLearningComputes" | ||
| ], | ||
| "operationId": "Compute_Update_CustomServices", | ||
| "description": "Updates the custom services list. The list of custom services provided shall be overwritten", |
Contributor
There was a problem hiding this comment.
Missing dot in end of this sentence
|
Hi @srivatsasinha, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Jul 15, 2022
teochaban
reviewed
Jul 15, 2022
| "description": "Type of the Environment Variable. Possible values are: local - For local variable, azureml - For azureml variables", | ||
| "type": "string", | ||
| "x-ms-enum": { | ||
| "name": "type", |
This was referenced Jul 15, 2022
Contributor
Author
|
/azp run unifiedPipeline |
|
Commenter does not have sufficient privileges for PR 19781 in repo Azure/azure-rest-api-specs |
added 2 commits
July 20, 2022 21:49
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @srivatsasinha your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
srivatsasinha
changed the title
added 2 commits
July 20, 2022 22:57
rkmanda
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
ArcturusZhang
approved these changes
Jul 25, 2022
ArcturusZhang
merged commit a54e912
into
Azure:dev-machinelearningservices-Microsoft.MachineLearningServices-2022-06-01-preview
11 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy 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.
-[ ] 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.
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.