Pushing new features in stable swagger #23071
Merged
Conversation
This file contains 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
|
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. [email protected] |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
Swagger Generation Artifacts
|
|
Hi, @srivatsasinha your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Generated ApiView
|
|
Hi @srivatsasinha, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Mar 14, 2023
added 2 commits
March 15, 2023 12:21
adrosa
suggested changes
Mar 16, 2023
| "name": "connect", | ||
| "target": 8888, | ||
| "published": 4444, | ||
| "hostIp": null |
There was a problem hiding this comment.
please share a good example file.
There was a problem hiding this comment.
There was a problem hiding this comment.
the caps are all wrong and hostIp being null has very specific meaning compared to not being present and you probably don't mean that
There was a problem hiding this comment.
share a good example file.
| ], | ||
| "volumes": [ | ||
| { | ||
| "type": "bind", |
There was a problem hiding this comment.
please share a good example.
| "EnvironmentVariable": { | ||
| "type": "object", | ||
| "properties": { | ||
| "type": { |
There was a problem hiding this comment.
this is actually a and opaq object with string
There was a problem hiding this comment.
didn't get you
| }, | ||
| "reference": { | ||
| "type": "string", | ||
| "description": "Image reference URL" |
There was a problem hiding this comment.
if you give me a url i cry. this is an oci reference.
There was a problem hiding this comment.
didn't get you
There was a problem hiding this comment.
it's just image reference not a url just remove word url
srivatsasinha
added
the
WaitForARMFeedback
visingla-ms
reviewed
Mar 28, 2023
| }, | ||
| "additionalProperties": true | ||
| }, | ||
| "Image": { |
There was a problem hiding this comment.
Added, Thanks for bringing it up.
visingla-ms
reviewed
Mar 28, 2023
| }, | ||
| "additionalProperties": true | ||
| }, | ||
| "EnvironmentVariable": { |
There was a problem hiding this comment.
Added, Thanks for bringing it up.
visingla-ms
reviewed
Mar 28, 2023
| }, | ||
| "additionalProperties": true | ||
| }, | ||
| "Docker": { |
There was a problem hiding this comment.
Added, Thanks for bringing it up.
visingla-ms
reviewed
Mar 28, 2023
| "Docker": { | ||
| "type": "object", | ||
| "properties": { | ||
| "privileged": { |
There was a problem hiding this comment.
It is always recommended to use enum instead of boolean, like here:
"mode" as enum with values: "privileged", "unprivileged".
That makes it extensible in future without causing ay breaking changes. Unless you are absolutely sure, it will always be just these values, needing it as boolean.
visingla-ms
reviewed
Mar 28, 2023
| "VolumeOptions": { | ||
| "type": "object", | ||
| "properties": { | ||
| "nocopy": { |
There was a problem hiding this comment.
There was a problem hiding this comment.
The entire configuration is a docker compose spec that we have ported and extended to our usecase. Most of these properties are standard docker configuration and sticking by the data type they define, they are supposed to be "boolean". We don't intent to diverge from this in future, hence we are fine keeping it as it is.
visingla-ms
reviewed
Mar 28, 2023
| } | ||
| } | ||
| }, | ||
| "TmpfsOptions": { |
There was a problem hiding this comment.
Added, Thanks for bringing it up.
visingla-ms
reviewed
Mar 28, 2023
| } | ||
| } | ||
| }, | ||
| "BindOptions": { |
There was a problem hiding this comment.
Added, Thanks for bringing it up.
visingla-ms
reviewed
Mar 28, 2023
| } | ||
| } | ||
| }, | ||
| "VolumeOptions": { |
There was a problem hiding this comment.
Added, Thanks for bringing it up.
visingla-ms
reviewed
Mar 28, 2023
| } | ||
| } | ||
| }, | ||
| "VolumeDefinition": { |
There was a problem hiding this comment.
Added, Thanks for bringing it up.
visingla-ms
reviewed
Mar 28, 2023
| }, | ||
| "additionalProperties": true | ||
| }, | ||
| "Endpoint": { |
There was a problem hiding this comment.
Added, Thanks for bringing it up.
visingla-ms
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
srivatsasinha
added
WaitForARMFeedback
visingla-ms
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
visingla-ms
approved these changes
Mar 29, 2023
|
Hi @raosuhas and @visingla-ms - Once merged, how long does it typically take to release these changes? Is there a fixed set of release dates for the ARM stable swagger changes? This will help us align marketing dates, thank you! |
ArcturusZhang
approved these changes
Mar 30, 2023
ArcturusZhang
merged commit ea7763c
into
Azure:release-machinelearningservices-Microsoft.MachineLearningServices-2023-04-01
ArcturusZhang
pushed a commit
that referenced
this pull request
Apr 18, 2023
…023 04 01 (#23450) * Adds base for updating Microsoft.MachineLearningServices from version stable/2022-10-01 to version 2023-04-01 * Updates readme * Updates API version in new specs and examples * [Stable] Bring Back schedule shutdown MLC models (#23039) * bring back schedule shutdown MLC models * add description --------- Co-authored-by: Naman Agarwal <[email protected]> * add minLength:1 prop to required strings (#23109) * [Stable] Add IdleShutdown properties and api (#23042) * [Stable] Add IdleShutdown properties and api * update version * remove api to update IdleShutdownSetting * Delete example --------- Co-authored-by: Naman Agarwal <[email protected]> * Pushing new features in stable swagger (#23071) * Pushing new features in stable swagger * Added example file * Triggering retest * Fixed version issue * Triggering retest * Removing OS Patching * Changes as per feedback, and add os patching back * Fix formatting * Removed Custom Service Update API * Fixed Example Files * Added as per review comments * Added as per review comments * Retrigger test --------- Co-authored-by: Srivatsa Sinha <[email protected]> * Add Registries 2023-04-01 Swagger (#23085) * add swagger + examples * fix readme * fix readme * switching to autogenerated registries swagger * fix spellcheck * update ga examples * previous API version for comparison = 2023-02-01-preview * new API version for comparison = 2023-04-01 * update examples * update swagger, examples to fix pr gates * fix lint diff errors * delete should have a 202 response, update createorupdate examples, fix removeRegions operation * removeRegions -> LRO POST operation * fix LRO options on removeRegions * add registryNameParamert * update swagger * update * PATCH property should have sku, identity properties * fix example --------- Co-authored-by: Komal Yadav <[email protected]> * MFE April 2023 staging (#23164) * add latest mfe.json * updated examples * add wasbs to known words * swap pendingupload to proper naming * align RPs on Azure Machine Learning Services * rename pendingUpload to verb: startPendingUpload * remove trailing slash startpendingupload * improve descriptions * add pattern to all resource name types + examples * update original-uri -> azure-async-operation * remove wasbs and mark credential usage as secret * test is changing all to azure-async-operation causes breaking change * the code is implemented where the original-uri is where you will find the final object post-polling * update examples to remove wasbsUri * reference registries instead for RegistryName * remove wasbs * original-uri -> azure-async-operation * update examples to empty secrets * CreateOrUpdatePendingUpload -> CreateOrUpdateStartPendingUpload * add pattern for workspaceName * x-ms-secret on the SASUri * switch back to original-uri given update from auto-rest folks --------- Co-authored-by: Kayla Ames <[email protected]> * update compute examples to ReadOnly * v5->v3 * PartialManagedServiceIdentity -> RegistryPartialManagedServiceIdentity * update ID for delete/cancel job/schedule location header * PrivateEndpointConnection -> RegistryPrivateEndpointConnection * more renames for Registry * align mlc with arm * update registry examples * update registryPrivateLinkServiceConnectionState in examples * update description arm id for registryPrivateEndpointConnections * update to preview --------- Co-authored-by: Naman Agarwal <[email protected]> Co-authored-by: Naman Agarwal <[email protected]> Co-authored-by: Teddy Todorov <[email protected]> Co-authored-by: srivatsasinha <[email protected]> Co-authored-by: Srivatsa Sinha <[email protected]> Co-authored-by: Komal Yadav <[email protected]> Co-authored-by: Komal Yadav <[email protected]> Co-authored-by: Kayla Ames <[email protected]>
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
…023 04 01 (Azure#23450) * Adds base for updating Microsoft.MachineLearningServices from version stable/2022-10-01 to version 2023-04-01 * Updates readme * Updates API version in new specs and examples * [Stable] Bring Back schedule shutdown MLC models (Azure#23039) * bring back schedule shutdown MLC models * add description --------- Co-authored-by: Naman Agarwal <[email protected]> * add minLength:1 prop to required strings (Azure#23109) * [Stable] Add IdleShutdown properties and api (Azure#23042) * [Stable] Add IdleShutdown properties and api * update version * remove api to update IdleShutdownSetting * Delete example --------- Co-authored-by: Naman Agarwal <[email protected]> * Pushing new features in stable swagger (Azure#23071) * Pushing new features in stable swagger * Added example file * Triggering retest * Fixed version issue * Triggering retest * Removing OS Patching * Changes as per feedback, and add os patching back * Fix formatting * Removed Custom Service Update API * Fixed Example Files * Added as per review comments * Added as per review comments * Retrigger test --------- Co-authored-by: Srivatsa Sinha <[email protected]> * Add Registries 2023-04-01 Swagger (Azure#23085) * add swagger + examples * fix readme * fix readme * switching to autogenerated registries swagger * fix spellcheck * update ga examples * previous API version for comparison = 2023-02-01-preview * new API version for comparison = 2023-04-01 * update examples * update swagger, examples to fix pr gates * fix lint diff errors * delete should have a 202 response, update createorupdate examples, fix removeRegions operation * removeRegions -> LRO POST operation * fix LRO options on removeRegions * add registryNameParamert * update swagger * update * PATCH property should have sku, identity properties * fix example --------- Co-authored-by: Komal Yadav <[email protected]> * MFE April 2023 staging (Azure#23164) * add latest mfe.json * updated examples * add wasbs to known words * swap pendingupload to proper naming * align RPs on Azure Machine Learning Services * rename pendingUpload to verb: startPendingUpload * remove trailing slash startpendingupload * improve descriptions * add pattern to all resource name types + examples * update original-uri -> azure-async-operation * remove wasbs and mark credential usage as secret * test is changing all to azure-async-operation causes breaking change * the code is implemented where the original-uri is where you will find the final object post-polling * update examples to remove wasbsUri * reference registries instead for RegistryName * remove wasbs * original-uri -> azure-async-operation * update examples to empty secrets * CreateOrUpdatePendingUpload -> CreateOrUpdateStartPendingUpload * add pattern for workspaceName * x-ms-secret on the SASUri * switch back to original-uri given update from auto-rest folks --------- Co-authored-by: Kayla Ames <[email protected]> * update compute examples to ReadOnly * v5->v3 * PartialManagedServiceIdentity -> RegistryPartialManagedServiceIdentity * update ID for delete/cancel job/schedule location header * PrivateEndpointConnection -> RegistryPrivateEndpointConnection * more renames for Registry * align mlc with arm * update registry examples * update registryPrivateLinkServiceConnectionState in examples * update description arm id for registryPrivateEndpointConnections * update to preview --------- Co-authored-by: Naman Agarwal <[email protected]> Co-authored-by: Naman Agarwal <[email protected]> Co-authored-by: Teddy Todorov <[email protected]> Co-authored-by: srivatsasinha <[email protected]> Co-authored-by: Srivatsa Sinha <[email protected]> Co-authored-by: Komal Yadav <[email protected]> Co-authored-by: Komal Yadav <[email protected]> Co-authored-by: Kayla Ames <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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:
Contribution checklist (MS Employees Only):
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 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.
-[x] 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.