[MFE] Reorder mfe.json spec for future consistency #14577
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
This reverts commit 7537c82.
|
Hi, @forteddyt 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. vsswagger@microsoft.com |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Guid used in model definition 'CertificateDatastoreCredentials' for property 'clientId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#L5620 |
|
| Guid used in model definition 'ServicePrincipalDatastoreCredentials' for property 'clientId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#L9100 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#L5980 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#L6017 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#L6934 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#L7291 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#L7669 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#L7692 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#L7700 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#L8281 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#L8379 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#L9216 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"machinelearningservices/resource-manager/readme.md", "tag":"package-2021-03-01-preview", "details":"The schema 'components·1dsxf3l·schemas·commandjob·properties·parameters·additionalproperties' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#/components/schemas/components·1dsxf3l·schemas·commandjob·properties·parameters·additionalproperties" |
|
| 💬 AutorestCore/Exception | "readme":"machinelearningservices/resource-manager/readme.md", "tag":"package-2021-03-01-preview", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"machinelearningservices/resource-manager/readme.md", "tag":"package-2021-03-01-preview", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| "readme":"machinelearningservices/resource-manager/readme.md", "tag":"package-2021-03-01-preview", "details":"Schema 'AmlComputeNodesInformation' has a property 'nextLink' that is already declared the parent schema 'ComputeNodesInformation' but isn't significantly different. The property has been removed from AmlComputeNodesInformation" |
|
| 💬 AutorestCore/Exception | "readme":"machinelearningservices/resource-manager/readme.md", "tag":"package-2021-03-01-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
This was referenced May 27, 2021
This was referenced May 27, 2021
ArcturusZhang
approved these changes
May 27, 2021
|
This is said to be purely a reordering of the operations. |
This was referenced May 27, 2021
This was referenced May 28, 2021
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @forteddyt your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @ArcturusZhang |
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Enabling java client (Azure#1) * Revert "Enabling java client (Azure#1)" (Azure#2) This reverts commit 26873d3. * Revert "Revert "Enabling java client (Azure#1)" (Azure#2)" This reverts commit 41d5801. * Revert "Enabling java client (Azure#1)" This reverts commit 7537c82. * reorder spec Co-authored-by: Harneet Virk <harnvir@microsoft.com>
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
What's the purpose of the update?
Our auto-generation now enforces specific ordering of definitions, properties, and paths. This will make future reviews of mfe.json easier, since ordering will be consistent. There are no schema changes, aside from ordering of definitions, properties, and paths. Ordering of parameters has not changed, either.
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.