-
Notifications
You must be signed in to change notification settings - Fork 5.5k
mediaservices microsoft.media 2023 01 01: Add Minimum TLS Version property #22614
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
mediaservices microsoft.media 2023 01 01: Add Minimum TLS Version property #22614
Conversation
Hi, @seaeunlee14 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. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
Accounts.json | 2023-01-01(0cdb206) | 2021-11-01(main) |
Accounts.json | 2023-01-01(0cdb206) | 2019-05-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.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-account-2023-01 | package-account-2023-01(0cdb206) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2023-01-01/Accounts.json#L411 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Accounts/stable/2023-01-01/Accounts.json#L476 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2023-01-01/Accounts.json#L665 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2023-01-01/Accounts.json#L672 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2023-01-01/Accounts.json#L691 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Accounts/stable/2023-01-01/Accounts.json#L698 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Accounts/stable/2023-01-01/Accounts.json#L985 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Accounts/stable/2023-01-01/Accounts.json#L1028 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Accounts/stable/2023-01-01/Accounts.json#L1229 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Accounts/stable/2023-01-01/Accounts.json#L1279 |
GetCollectionResponseSchema |
The response in the GET collection operation 'PrivateLinkResources_List' does not match the response definition in the individual GET operation 'PrivateLinkResources_Get' . Location: Accounts/stable/2023-01-01/Accounts.json#L1332 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Accounts/stable/2023-01-01/Accounts.json#L1332 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Accounts/stable/2023-01-01/Accounts.json#L1376 |
GetCollectionResponseSchema |
The response in the GET collection operation 'PrivateEndpointConnections_List' does not match the response definition in the individual GET operation 'PrivateEndpointConnections_Get' . Location: Accounts/stable/2023-01-01/Accounts.json#L1426 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Accounts/stable/2023-01-01/Accounts.json#L1426 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Accounts/stable/2023-01-01/Accounts.json#L1470 |
ResourceNameRestriction |
The resource name parameter 'locationName' should be defined with a 'pattern' restriction. Location: Accounts/stable/2023-01-01/Accounts.json#L1625 |
ResourceNameRestriction |
The resource name parameter 'locationName' should be defined with a 'pattern' restriction. Location: Accounts/stable/2023-01-01/Accounts.json#L1675 |
ResourceNameRestriction |
The resource name parameter 'locationName' should be defined with a 'pattern' restriction. Location: Accounts/stable/2023-01-01/Accounts.json#L1729 |
GetOperation200 |
The get operation should only return 200. Location: Accounts/stable/2023-01-01/Accounts.json#L1741 |
XmsParameterLocation |
The parameter 'SubscriptionId' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Accounts/stable/2023-01-01/Accounts.json#L1834 |
XmsParameterLocation |
The parameter 'ApiVersion' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Accounts/stable/2023-01-01/Accounts.json#L1849 |
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: Accounts/stable/2023-01-01/Accounts.json#L64 |
|
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: Accounts/stable/2023-01-01/Accounts.json#L196 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Accounts/stable/2023-01-01/Accounts.json#L298 |
|
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: Accounts/stable/2023-01-01/Accounts.json#L302 |
|
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: Accounts/stable/2023-01-01/Accounts.json#L334 |
|
Schema should have a description or title. Location: Accounts/stable/2023-01-01/Accounts.json#L602 |
|
Schema should have a description or title. Location: Accounts/stable/2023-01-01/Accounts.json#L611 |
|
Schema should have a description or title. Location: Accounts/stable/2023-01-01/Accounts.json#L628 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/mediaservices/resource-manager/readme.md tag: specification/mediaservices/resource-manager/readme.md#tag-package-account-2023-01 |
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
Tag package-account-2023-01; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 102, untested: 30, failed: 0, passed: 72
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView 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.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi, @seaeunlee14 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
@@ -26,7 +26,7 @@ These are the global settings for the MediaServices API. | |||
|
|||
``` yaml | |||
openapi-type: arm | |||
tag: package-streaming-2022-11 | |||
tag: package-2023-01 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you rename the tag to package-account-2023-01
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Hi, @seaeunlee14, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
|
||
These settings apply only when `--tag=package-account-2023-01` is specified on the command line. | ||
|
||
```yaml $(tag) == 'package-account-2023-01' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you need the space here, similar to how you added below?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
…dd Minimum TLS Version property (#2799) Create to sync Azure/azure-rest-api-specs#22614 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/mediaservices?expand=1)
…perty (Azure#22614) * Adds base for updating Microsoft.Media/Accounts from version stable/2021-11-01 to version 2023-01-01 * Updates readme * Updates API version in new specs and examples * add tls version * add default * add to readme test * fix readme --------- Co-authored-by: Sea Eun Lee <[email protected]>
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.