[test report links] Update ApplicationGroups.json #3266
Closed
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
[suppression test] add suppression file for pr service link
add python config
This reverts commit 8aad719.
Next Steps to mergeNext steps that must be taken to merge this PR:
|
Swagger Generation Artifacts
|
Generated ApiView
|
Swagger Validation Report
|
| Compared specs (v0.10.7) | new version | base version |
|---|---|---|
| ApplicationGroups.json | 2024-01-01(122cdbd) | 2024-01-01(main) |
| servicelinker.json | 2022-05-01(122cdbd) | 2022-05-01(main) |
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups' removed or restructured? Old: Microsoft.EventHub/stable/2024-01-01/ApplicationGroups.json#L37:5 |
|
The new version is missing an operation that was found in the old version. Was operationId 'Linker_Delete' removed or restructured? New: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L74:5 Old: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L74:5 |
|
"new":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/122cdbd77c4d5987f7938674a60b03a5f66212e0/specificationRepositoryConfiguration.json", "old":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/main/specificationRepositoryConfiguration.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.427/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specificationRepositoryConfiguration.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp/oad-gk69pC 2: FATAL: swagger-document/loader - FAILED 3: FATAL: Error: File 'file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specificationRepositoryConfiguration.json' is not a valid OpenAPI 2.0 definition (expected 'swagger: 2.0') 4: Error: File 'file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specificationRepositoryConfiguration.json' is not a valid OpenAPI 2.0 definition (expected 'swagger: 2.0')" |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️❌LintDiff: 1 Errors, 2 Warnings failed [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-2022-05-01 | package-2022-05-01(122cdbd) | package-2022-05-01(main) |
| package-2024-01 | package-2024-01(122cdbd) | package-2024-01(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The nested resource 'ApplicationGroup' does not have list operation, please add it. Location: Microsoft.EventHub/stable/2024-01-01/ApplicationGroups.json#L198 |
|
| A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.EventHub/stable/2024-01-01/ApplicationGroups.json#L37 |
RPC-Get-V1-11 | |
| The resource LinkerResource does not have a corresponding delete operation. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L693 |
RPC-Delete-V1-05 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'linkerName' should be defined with a 'pattern' restriction. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L74 |
|
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L168 |
|
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L198 |
|
Properties of a PATCH request body must not be required, property:authType. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L198 |
|
The async patch operation should return 202. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L203 |
|
The resource name parameter 'linkerName' should be defined with a 'pattern' restriction. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L225 |
|
A 202 response should include an Location response header. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L259 |
|
The resource name parameter 'linkerName' should be defined with a 'pattern' restriction. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L271 |
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApplicationGroupModel'. Consider using the plural form of 'ApplicationGroup' 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.EventHub/stable/2024-01-01/ApplicationGroups.json#L42 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/stable/2024-01-01/ApplicationGroups.json#L50 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApplicationGroupModel'. Consider using the plural form of 'ApplicationGroup' 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.EventHub/stable/2024-01-01/ApplicationGroups.json#L95 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/stable/2024-01-01/ApplicationGroups.json#L102 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApplicationGroupModel'. Consider using the plural form of 'ApplicationGroup' 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.EventHub/stable/2024-01-01/ApplicationGroups.json#L138 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/stable/2024-01-01/ApplicationGroups.json#L145 |
|
| 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.EventHub/stable/2024-01-01/ApplicationGroups.json#L205 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L52 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L65 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L88 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L104 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L132 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L163 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L188 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L219 |
|
| OperationId should contain the verb: 'validatelinker' in:'Linker_Validate'. Consider updating the operationId Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L230 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L246 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L265 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L288 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L304 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GetConfiguration Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L317 |
|
| Use the latest version v5 of types.json. Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L324 |
️️✔️~[NotRequired_Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌Avocado: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The example JSON file is not referenced from the swagger file. readme: specification/eventhub/resource-manager/readme.md json: 2024-01-01/examples/ApplicationGroup/ApplicationGroupListByNamespace.json |
|
The example JSON file is not referenced from the swagger file. readme: specification/servicelinker/resource-manager/readme.md json: stable/2022-05-01/examples/DeleteLink.json |
️❌ModelValidation: 4 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L693:23 ExampleUrl: stable/2022-05-01/examples/PutLink.json#L25:15 |
|
id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L693:23 ExampleUrl: stable/2022-05-01/examples/PutLink.json#L41:15 |
|
Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L252:22 ExampleUrl: stable/2022-05-01/examples/ValidateLinkSuccess.json |
|
"role":"Model Validation", "url":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/122cdbd77c4d5987f7938674a60b03a5f66212e0/specificationRepositoryConfiguration.json" |
️❌SemanticValidation: 8 Errors, 0 Warnings failed [Detail]
️️✔️~[NotRequired_Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
|
Please address or respond to feedback from the ARM API reviewer. |
This was referenced Apr 8, 2024
mgmt_tsp_automation_conf
switch java branch override
|
/azp run |
|
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts. |
|
Pull request contains merge conflicts. |
This was referenced Apr 22, 2024
This was referenced Apr 22, 2024
This was referenced Apr 22, 2024
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 (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.