Add NetworkSecurityPerimeterConfigurations Swagger #22960
Merged
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
|
Hi, @beoberha 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(7d6a770) | package-preview-2022-11(release-sql-Microsoft.Sql-2022-11-01-preview) |
[must fix]The following errors/warnings are introduced by current PR:
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
ghost
added
the
Swagger Generation Artifacts
|
|
Hi, @beoberha your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Generated ApiView
|
|
Hi @beoberha, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Please fix these lintdiff issues manually in swagger file: ❌ XmsIdentifierValidation | Missing identifier id in array item propertyLocation: Microsoft.Sql/preview/2022-11-01-preview/NetworkSecurityPerimeterConfigurations.json#L211 | we have the x-ms-identifier tag/attribute in DSmainDev, but due to our .NET client version for unit tests in DSMainDev is very old. It will trigger unit test clients generation failure. Thus, we turn off them. |
for rest of them, we could ask for exception. |
ericshape
approved these changes
Mar 8, 2023
|
We will fix the following lintDiff errors in sql swagger generation code:
|
|
@raych1 - this PR is ready for review and merge, please. |
mentat9
reviewed
Mar 10, 2023
| "NSPProvisioningIssueProperties": { | ||
| "type": "object", | ||
| "properties": { | ||
| "issueType": { |
There was a problem hiding this comment.
There is not going to be a fixed set of values for this. We will continually add them as issues arise
There was a problem hiding this comment.
You can always add enum members, although it now requires a new API version. There is value in that. Not blocking ARM signoff on this, but recommend you take another look at enums.
mentat9
reviewed
Mar 10, 2023
| "issueType": { | ||
| "type": "string" | ||
| }, | ||
| "severity": { |
There was a problem hiding this comment.
There is no fixed set of values for this yet, if ever
There was a problem hiding this comment.
Not blocking ARM signoff on this, but I'd highly recommend you consider making this an enum. If creating new severities is too easy, the property is likely to quickly become nearly useless. Same for issueType. It's valuable for you to control these: for example, if this property ever goes into telemetry, you can make much stronger inferences from it. Clients can easily understand the options and limits when it's an enum.
mentat9
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
mentat9
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
|
@beoberha - Signed off for ARM with comments. |
|
@raych1 do we know the impact if we set up the ResourceNameRestriction?
|
raych1
pushed a commit
that referenced
this pull request
May 19, 2023
* Adds base for updating Microsoft.Sql from version preview/2022-08-01-preview to version 2022-11-01-preview * Updates readme * Updates API version in new specs and examples * Add Swagger API changes required for progress-reporting related changes in DatabaseOperations (#22669) * Update swagger (#22715) * Follow-up Swagger API changes required for progress-reporting related changes in DatabaseOperations (#22775) * Add Swagger API changes required for progress-reporting related changes in DatabaseOperations * Follow up changes required for progress-reporting related changes in DatabaseOperations * updated example file * Added Failed case in list-operations examples * Update Microsoft.Sql ManagedInstance 2022-11-01-preview Swagger Docs (#22899) * Update Microsoft.sql ManagedInstance 2022-11-01-preview Swagger Docs * Address Swagger Validation Errors * Modify custom-words.txt * Manually updating arm-id format to match stable 2021-11-01 version * Adding provisioning state changes * fixing validation * adding missing space * Remove HTTP 200 from Start/Stop Actions as we only return HTTP 202 --------- Co-authored-by: Jovana Toroman <jtoroman@microsoft.com> * Update DateTime to ISO-8601 format in example file (#22986) * Add Swagger API changes required for progress-reporting related changes in DatabaseOperations * Follow up changes required for progress-reporting related changes in DatabaseOperations * updated example file * Added Failed case in list-operations examples * Update DateTime to ISo-8601 format in example file * Enable TryPlannedBeforeForcedFailover for SQL DB Failover Group (#22673) * Enable TryPlannedBeforeForcedFailover for SQL DB Failover Group * Modify example file * Add example * Fix ModelValidation issues * Fix ModelValidation issues * Add new controller * Modify example * Modify example * Update server name * Fix LintDiff * Fix model validation errors * Fix PostOperationAsyncResponseValidation, Unfix LroLocationHeader,ResourceNameRestriction * Fix PostOperationAsyncResponseValidation * Fix pending items * Update doc * Remove empty/unschematized object --------- Co-authored-by: subhrob <subhrob@microsoft.com> * [DO NOT MERGE] Add Archive option to LTR Policy for SQL DB (#22697) * add archival changes to LTRPolicy * fix LongTermRetentionPolicies swagger file * fix check failures * redo swagger * Update swagger documentation for Managed Instance start-stop actions (#22992) * Add NetworkSecurityPerimeterConfigurations Swagger (#22960) * Add NetworkSecurityPerimeterConfigurations Swagger * Fixes round 1 * Fixes round 2 * Fixes Round 3 * Fixes Round 4 * Fix Round 5 * fixing enum (#22995) Co-authored-by: Jovana Toroman <jtoroman@microsoft.com> * add changes (#23120) * Carry all minor changes to dev sql microsoft.sql 2022 11 01 preview (#23337) * Revert "add changes (#23120)" This reverts commit 5c348d2. Revert "[DO NOT MERGE] Add Archive option to LTR Policy for SQL DB (#22697)" This reverts commit 559f7f4. * Carrying minor changes to release branch for Microsoft.Sql 2022-11-01-preview * Reverting DatabaseAdvisors * Further reverting problematic files * Reverting a few example files * Adding back arm-id to a few files * Reverting error message change in ManagedDatabaseRestoreDetails.json, Jobs.json,ServerDevOpsAudit.json, and TransparentDataEncryptions.json * Minor fixes for Turkey name change and missing x-ms-identifier (#23637) * Fixing issues with a few breaking changes (#23943) * Minor fixes for Turkey name change and missing x-ms-identifier * Adding back missing arm-id and other missing property issues causing breaking changes incorrectly. * Fixing prettier issue with ManagedDatabases.json * Fixing arm-id format in 4 examples * Adding missing location for 202 responses on sync examples --------- Co-authored-by: Ji Wang <wangjiprc@gmail.com> Co-authored-by: Mohit Agarwal <mohitagarwal@microsoft.com> Co-authored-by: GalGoldi72 <124780962+GalGoldi72@users.noreply.github.com> Co-authored-by: ilijadivljan-ms <122982104+ilijadivljan-ms@users.noreply.github.com> Co-authored-by: Jovana Toroman <jtoroman@microsoft.com> Co-authored-by: subhrob <subhro.bhattacharya@gmail.com> Co-authored-by: subhrob <subhrob@microsoft.com> Co-authored-by: CelinaJiangJXY <124339390+CelinaJiangJXY@users.noreply.github.com> Co-authored-by: beoberha <51964155+beoberha@users.noreply.github.com> Co-authored-by: toki95 <35834415+toki95@users.noreply.github.com>
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 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.
-[x] 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.