[typespec-next] React to Azure/typespec-azure#3326#25026
Merged
mikeharder merged 5 commits intoAzure:typespec-nextfrom Jul 28, 2023
Merged
[typespec-next] React to Azure/typespec-azure#3326#25026mikeharder merged 5 commits intoAzure:typespec-nextfrom
mikeharder merged 5 commits intoAzure:typespec-nextfrom
Conversation
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| fleets.json | 2022-09-02-preview(068edff) | 2022-09-02-preview(main) |
| fleets.json | 2023-03-15-preview(068edff) | 2023-03-15-preview(main) |
| containerstorage.json | 2023-03-01-preview(068edff) | 2023-03-01-preview(main) |
| TrafficController.json | 2023-05-01-preview(068edff) | 2023-05-01-preview(main) |
| azuresphere.json | 2022-09-01-preview(068edff) | 2022-09-01-preview(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2023-03-preview | package-2023-03-preview(068edff) | package-2023-03-preview(typespec-next) |
| package-2022-09-preview | package-2022-09-preview(068edff) | package-2022-09-preview(typespec-next) |
| package-2023-03-01-preview | package-2023-03-01-preview(068edff) | package-2023-03-01-preview(typespec-next) |
| package-2023-05-01-preview | package-2023-05-01-preview(068edff) | package-2023-05-01-preview(typespec-next) |
| package-2022-09-01-preview | package-2022-09-01-preview(068edff) | package-2022-09-01-preview(typespec-next) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
ResourceNameRestriction |
The resource name parameter 'imageName' should be defined with a 'pattern' restriction. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L762 |
RepeatedPathInfo |
The 'imageName' already appears in the path, please don't repeat it in the request body. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L839 |
ParametersInPost |
$filter is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L971 |
ParametersInPost |
$top is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L971 |
ParametersInPost |
$skip is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L971 |
ParametersInPost |
$maxpagesize is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L971 |
ParametersInPost |
$filter is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1033 |
ParametersInPost |
$top is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1033 |
ParametersInPost |
$skip is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1033 |
ParametersInPost |
$maxpagesize is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1033 |
ParametersInPost |
$filter is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1104 |
ParametersInPost |
$top is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1104 |
ParametersInPost |
$skip is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1104 |
ParametersInPost |
$maxpagesize is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1104 |
ParametersInPost |
$filter is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1166 |
ParametersInPost |
$top is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1166 |
ParametersInPost |
$skip is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1166 |
ParametersInPost |
$maxpagesize is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1166 |
LroPostReturn |
A LRO POST operation must have both 200 & 202 return codes. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L1999 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L2052 |
ResourceNameRestriction |
The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L2219 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'Devices' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L2471 |
ConsistentPatchProperties |
The property 'properties.deviceGroupId' in the request body either not apppear in the resource model or has the wrong level. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L2753 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L2767 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L2948 |
| Schema should have a description or title. Location: fleet/preview/2023-03-15-preview/fleets.json#L1664 |
|
| 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.ContainerStorage/preview/2023-03-01-preview/containerstorage.json#L1416 |
|
| 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.ContainerStorage/preview/2023-03-01-preview/containerstorage.json#L1445 |
|
| Schema should have a description or title. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L1130 |
|
| Schema should have a description or title. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L1241 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
|
Hi, @mikeharder! Thank you for your pull request. To help get your PR merged: Generated ApiView comment added to this PR. You can use ApiView to show API versions diff. |
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Jul 27, 2023
Member
Author
|
Converting to draft until TypeSpecValidation is passing |
This was referenced Jul 27, 2023
This was referenced Jul 27, 2023
timotheeguerin
approved these changes
Jul 28, 2023
markcowl
approved these changes
Jul 28, 2023
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.
No description provided.