Add TLS 1.3 to valid TLS version: Autogenerated swagger for rest-api #26937
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
jha1bhavna
requested review from
jamestao,
ericshape and
jeremyfrosti
as code owners
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| Servers.json | 2023-05-01-preview(19a4e38) | 2023-05-01-preview(main) |
| Rule | Message |
|---|---|
|
The new version adds a x-ms-enum extension. New: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L1067:9 Old: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L1040:9 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-preview-2023-05 | package-preview-2023-05(19a4e38) | package-preview-2023-05(main) |
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 'serverName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L171 |
|
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L178 |
|
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.Sql/preview/2023-05-01-preview/Servers.json#L222 |
|
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.Sql/preview/2023-05-01-preview/Servers.json#L222 |
|
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.Sql/preview/2023-05-01-preview/Servers.json#L222 |
|
The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L228 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L264 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L281 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L311 |
|
The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L331 |
|
200 response schema in long running PATCH operation is missing ProvisioningState property. A LRO PATCH operations 200 response schema must have ProvisioningState specified. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L355 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L367 |
|
The resource name parameter 'serverName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L379 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L422 |
|
The resource name parameter 'serverName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L437 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L471 |
|
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L549 |
|
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L772 |
|
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L864 |
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L26 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L77 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L126 |
|
| The response of operation:'Servers_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L172 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L178 |
|
| The response of operation:'Servers_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L222 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L228 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L287 |
|
| The response of operation:'Servers_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L325 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L331 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.Sql/preview/2023-05-01-preview/Servers.json#L379 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/sql/resource-manager/readme.md tag: specification/sql/resource-manager/readme.md#tag-package-composite-v5 |
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Dec 4, 2023
AzureRestAPISpecReview
added
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
This was referenced Dec 4, 2023
ericshape
reviewed
Dec 5, 2023
| } | ||
| ] | ||
| } | ||
| "type": "string" | ||
| }, |
ericshape
reviewed
Dec 5, 2023
Comment on lines
+1058
to
+1070
| "description": "Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'", | ||
| "enum": [ | ||
| "None", | ||
| "1.0", | ||
| "1.1", | ||
| "1.2", | ||
| "1.3" | ||
| ], | ||
| "type": "string", | ||
| "x-ms-enum": { | ||
| "name": "MinimalTlsVersion", | ||
| "modelAsString": true | ||
| } |
There was a problem hiding this comment.
yes, it is what we need for the enum string def.
ericshape
reviewed
Dec 5, 2023
Comment on lines
701
to
705
| "x-ms-arm-id-details": { | ||
| "allowedResources": [ | ||
| {} | ||
| ] | ||
| }, |
There was a problem hiding this comment.
revert this change in this PR
ericshape
approved these changes
Dec 6, 2023
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
do we know why the CLA pipeline is paused? |
|
No, I don't know about this. Do I need to do something here?
From: Ji Wang ***@***.***>
Sent: Saturday, December 9, 2023 3:08 AM
To: Azure/azure-rest-api-specs ***@***.***>
Cc: Bhavna Jha ***@***.***>; Author ***@***.***>
Subject: Re: [Azure/azure-rest-api-specs] Add TLS 1.3 to valid TLS version: Autogenerated swagger for rest-api (PR #26937)
do we know why the CLA pipeline is paused?
-
Reply to this email directly, view it on GitHub<#26937 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A5EV4C5J6YH2KD2FN5CEICDYIOCERAVCNFSM6AAAAABAF2J7ICVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNBXHA3TGMRQG4>.
You are receiving this because you authored the thread.Message ID: ***@***.******@***.***>>
|
mikekistler
added
the
Approved-BreakingChange
ericshape
removed
the
BreakingChangeReviewRequired
jha1bhavna
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
jha1bhavna
added
ARMSignedOff
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
ms-zhenhua
added
ARMSignedOff
|
/pr RequestMerge |
ms-zhenhua
approved these changes
Dec 14, 2023
arifibrahim4
pushed a commit
that referenced
this pull request
Feb 26, 2024
…26937) * Autogenerated swagger for rest-api * Removing extra changes
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.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
ARMReviewlabel.Click here to see the diagram footnotes
Diagram footnotes
[1] ARM review queue (for merge queues, see [2])
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] 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 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
Swagger-Suppression-Process
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.