Blueprints: Make layout readOnly #14418
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, @stuartko 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 |
|---|---|
|
The read only property has changed from 'false' to 'true'. New: Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json#L973:9 Old: Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json#L973:9 |
️⚠️LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json#L179 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Blueprint/preview/2018-11-01-preview/assignmentOperation.json#L254 |
|
| The operation 'Assignments_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json#L133 |
|
| 'CloudError' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json#L1389 |
|
| 'error' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json#L1392 |
|
| The API version:2018-11-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json#L6 |
|
| The API version:2018-11-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json#L6 |
|
| The API version:2018-11-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Blueprint/preview/2018-11-01-preview/assignmentOperation.json#L6 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: SubscriptionBlueprint Location: Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json#L96 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ManagementGroupBlueprint Location: Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json#L96 |
️️✔️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: 3 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"blueprint/resource-manager/readme.md", "tag":"package-2018-11-preview", "details":"The schema 'ParameterDefinition-defaultValue' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json#/components/schemas/ParameterDefinition-defaultValue" |
|
| "readme":"blueprint/resource-manager/readme.md", "tag":"package-2018-11-preview", "details":"The schema 'ParameterDefinition-allowedValuesItem' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json#/components/schemas/ParameterDefinition-allowedValuesItem" |
|
| "readme":"blueprint/resource-manager/readme.md", "tag":"package-2018-11-preview", "details":"The schema 'RoleAssignmentArtifactProperties-principalIds' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json#/components/schemas/RoleAssignmentArtifactProperties-principalIds" |
|
| 💬 AutorestCore/Exception | "readme":"blueprint/resource-manager/readme.md", "tag":"package-2018-11-preview", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"blueprint/resource-manager/readme.md", "tag":"package-2018-11-preview", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"blueprint/resource-manager/readme.md",
"tag":"package-2018-11-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
|
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=215961&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 128 " |
️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
warn Skip initScript due to not configured command sudo apt-get install -y dotnet-sdk-5.0 command autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/blueprint/resource-manager/readme.md cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied
️✔️Microsoft.Azure.Management.Blueprint [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
command sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️preview/blueprint/mgmt/2018-11-01-preview/blueprint [View full logs] [Release SDK Changes]info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] ### New Content info [Changelog] info [Changelog] - New struct `CloudError` info [Changelog] - New struct `ErrorAdditionalInfo` info [Changelog] - New struct `ErrorResponse` info [Changelog] info [Changelog] Total 0 breaking change(s), 6 additive change(s). info [Changelog]
️⚠️ azure-sdk-for-js warning [Detail]
⚠️Warning [Logs] Generate from 034ab1a54f22aded1e21a999c9572e345491f38b. SDK Automation 14.0.0warn Skip initScript due to not configured command autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/blueprint/resource-manager/readme.md warn No file changes detected after generation warn No package detected after generation
️⚠️ azure-sdk-for-python warning [Detail]
command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts. cmderr [automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible. cmderr [automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts. cmderr [automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible. cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
️✔️azure-mgmt-blueprint [View full logs] [Release SDK Changes]
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs] Generate from 034ab1a54f22aded1e21a999c9572e345491f38b. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json cmderr [generateScript.sh] (node:2590) UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, unlink '/home/vsts/work/1/s/azure-resource-manager-schemas/schemas/2017-11-11-preview/Microsoft.Blueprint.json' cmderr [generateScript.sh] (Use `node --trace-warnings ...` to show where the warning was created) cmderr [generateScript.sh] (node:2590) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1) cmderr [generateScript.sh] (node:2590) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
️✔️blueprint [View full logs] [Preview Schema Changes]
|
Hi @stuartko, 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. |
This was referenced May 14, 2021
ruowan
approved these changes
May 18, 2021
This was referenced May 18, 2021
Closed
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
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.
This marks our "layout" property for Blueprints as readOnly. It has always effectively been readOnly to our service, but wasn't represented as such in the swagger.
We've already discussed this change with the review board, and it has been granted preliminary approval (by Jeffrey) as not being a true breaking change:
"Technically, this change IS a breaking change because it can impact SDKs which then impact customer code.
However, since it never worked, we’ll approve any PR with this change in it."
Changelog
Please ensure to add changelog with 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
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.