update resource name patterns and response codes for CI check for testbase 2023-11-01-preview#26621
Merged
Merged
Conversation
|
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| testbase.json | 2023-11-01-preview(c4c8ef4) | 2022-04-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-11-01-preview | package-2023-11-01-preview(c4c8ef4) | package-2023-11-01-preview(published/Azure/azure-rest-api-specs-pr/gyz0072004-testbase-Microsoft.TestBase-2023-11-01-preview) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L330 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L409 |
PostResponseCodes |
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L508 |
ResourceNameRestriction |
The resource name parameter 'availableOSResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L712 |
ResourceNameRestriction |
The resource name parameter 'flightingRingResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L852 |
ResourceNameRestriction |
The resource name parameter 'testTypeResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1273 |
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1488 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1570 |
PostResponseCodes |
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1675 |
LroExtension |
Operations with a 202 response must specify x-ms-long-running-operation: true.Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1782 |
PostResponseCodes |
An async POST operation must set ''x-ms-long-running-operation' : true'. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1782 |
XMSLongRunningOperationProperty |
If an operation's (PUT/POST/PATCH/DELETE) responses have Location or Azure-AsyncOperation headers then it MUST have the property x-ms-long-running-operation set to trueLocation: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1820 |
ResourceNameRestriction |
The resource name parameter 'testSummaryName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1892 |
ResourceNameRestriction |
The resource name parameter 'testResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1996 |
ResourceNameRestriction |
The resource name parameter 'osUpdateResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2095 |
ResourceNameRestriction |
The resource name parameter 'favoriteProcessResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2196 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2197 |
ResourceNameRestriction |
The resource name parameter 'testResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2345 |
ResourceNameRestriction |
The resource name parameter 'testResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2411 |
ResourceNameRestriction |
The resource name parameter 'analysisResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2411 |
ResourceNameRestriction |
The resource name parameter 'testResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2474 |
ResourceNameRestriction |
The resource name parameter 'testResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2522 |
ResourceNameRestriction |
The resource name parameter 'testResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2570 |
ResourceNameRestriction |
The resource name parameter 'emailEventResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2672 |
ResourceNameRestriction |
The resource name parameter 'customerEventName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2767 |
ProvisioningStateSpecifiedForLROPut |
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2768 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2768 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2836 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L3320 |
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ActionRequestsModel'. Consider using the plural form of 'ActionRequests' 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.TestBase/preview/2023-11-01-preview/actionrequest.json#L42 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Nov 8, 2023
This was referenced Nov 8, 2023
abaa3de to
c4c8ef4
Compare
rankanggong
approved these changes
Nov 9, 2023
8f46946
into
published/Azure/azure-rest-api-specs-pr/gyz0072004-testbase-Microsoft.TestBase-2023-11-01-preview
sjanamma
pushed a commit
that referenced
this pull request
Nov 30, 2023
….TestBase-2023-11-01-preview' (#26488) * add or modify files * update readme files * fix samples * update resource name patterns and response codes for CI check for testbase 2023-11-01-preview (#26621) * update resource name patterns * update editable responce codes * update descriptions * try to fix the suppression (#26755) * try to fix suppression again (#26810)
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
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
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. 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 Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReviewlabel.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
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.