Swagger Documentation for Outbound Firewall Rules #13820
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, @VMMicrosoft 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
|
| Rule | Message |
|---|---|
|
The response of operation:'OutboundFirewallRules_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2021-02-01-preview/OutboundFirewallRules.json#L20 |
|
The response of operation:'OutboundFirewallRules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2021-02-01-preview/OutboundFirewallRules.json#L63 |
| 'outboundRuleFqdn' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Sql/preview/2021-02-01-preview/OutboundFirewallRules.json#L33 |
|
| 'outboundRuleFqdn' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Sql/preview/2021-02-01-preview/OutboundFirewallRules.json#L76 |
|
| 'parameters' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Sql/preview/2021-02-01-preview/OutboundFirewallRules.json#L82 |
|
| 'outboundRuleFqdn' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Sql/preview/2021-02-01-preview/OutboundFirewallRules.json#L137 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Model definition 'FirewallRule' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Sql/preview/2021-02-01-preview/FirewallRules.json#L308 |
|
Model definition 'ProxyResourceWithWritableName' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Sql/preview/2021-02-01-preview/FirewallRules.json#L298 |
|
The response of operation:'BackupShortTermRetentionPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2021-02-01-preview/BackupShortTermRetentionPolicies.json#L20 |
|
The response of operation:'ExtendedDatabaseBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2021-02-01-preview/BlobAuditing.json#L20 |
|
The response of operation:'ExtendedServerBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2021-02-01-preview/BlobAuditing.json#L174 |
|
The response of operation:'ServerBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2021-02-01-preview/BlobAuditing.json#L314 |
|
The response of operation:'DatabaseBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2021-02-01-preview/BlobAuditing.json#L454 |
|
The response of operation:'DataWarehouseUserActivities_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2021-02-01-preview/DataWarehouseUserActivities.json#L20 |
|
The response of operation:'DatabaseAdvisors_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2021-02-01-preview/DatabaseAdvisors.json#L75 |
|
The response of operation:'DatabaseAutomaticTuning_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2021-02-01-preview/DatabaseAutomaticTuning.json#L20 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.8.9)
- original: preview/2020-11-01-preview/Servers.json <---> new: preview/2021-02-01-preview/Servers.json
️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
|
"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2021-02", "details":"Error: Plugin pre-namer reported failure." |
|
"readme":"sql/resource-manager/readme.md", "tag":"package-composite-v5", "details":"Error: Plugin pre-namer reported failure." |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
ghost
added
the
Swagger Generation Artifacts
|
|
Hi @VMMicrosoft, Your PR has some issues. Please fix the CI sequentially by following the order of
|
ericshape
requested changes
Apr 7, 2021
| @@ -108,6 +108,7 @@ input-file: | |||
| - Microsoft.Sql/preview/2021-02-01-preview/ManagedServerSecurityAlertPolicies.json | |||
| - Microsoft.Sql/preview/2021-02-01-preview/Operations.json | |||
| - Microsoft.Sql/preview/2021-02-01-preview/OperationsHealth.json | |||
| - Microsoft.Sql/preview/2021-02-01-preview/OutboundFirewallRules.json | |||
There was a problem hiding this comment.
please also add - Microsoft.Sql/preview/2021-02-01-preview/OutboundFirewallRules.json to the bottom of v5 sdk tag if you want it to the latest sdk.
| @@ -19,6 +19,8 @@ | |||
| "version": "12.0", | |||
| "state": "Ready", | |||
| "workspaceFeature": "Connected", | |||
| "publicNetworkAccess": "Enabled", | |||
There was a problem hiding this comment.
make sure you have done all these changes for example files in DSMainDev repo at the same time.
|
feel free to ignore these LintDiff errors. SQL DB does not support it until now.
|
|
the .net sdk errors are expected due to we have v5 sdk tag. and .net sdk has breaking changes. |
|
Hi, @VMMicrosoft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @akning-ms |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
zcxcasd
added
ARMChangesRequested
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
ericshape
approved these changes
Apr 14, 2021
There was a problem hiding this comment.
LGTM
All the failed checks are expected.
- the systemData lint diff errors are expected.
- the .net SDK errors are also expected, @viparek is working on it now.
@akning-ms can you review and merge this PR to the dev branch? Thanks!
akning-ms
reviewed
Apr 15, 2021
| @@ -523,7 +523,7 @@ | |||
| ], | |||
| "type": "string", | |||
| "x-ms-enum": { | |||
| "name": "ServerPublicNetworkAccess", | |||
| "name": "ServerNetworkAccessFlag", | |||
There was a problem hiding this comment.
What is the reason to rename this enum name? as it create SDK breaking change
There was a problem hiding this comment.
The enum is being used in more places with this change, so we renamed it to make it more generic.
akning-ms
added a commit
that referenced
this pull request
May 10, 2021
* Adds base for updating Microsoft.Sql from version preview/2020-11-01-preview to version 2021-02-01-preview * Updates readme * Updates API version in new specs and examples * Fix Integer format: S360 swagger lint issues in 2021-02-01 (#13855) * Update integer format * update typo * Swagger Documentation for Outbound Firewall Rules (#13820) * Swagger Documentation for Outbound Firewall Rules * Add the new file to v5 Co-authored-by: Vineet Mahadik <[email protected]> * Swagger Documentation For Database Resource With Ledger (#13916) * adding database swagger files * modifying example * Fixing to be boolean * adding database extensions and database operations * adding other database examples * removing database_legacy, adding usages * removing usages * removing databases_legacy from readme * Swagger Documentation For Ledger Digest Upload (#13871) * adding ledger api * Fixes from validation * removing required endpoint parameter, adding ledgerName (current) to id * removing 201 response from resource, renaming ledgerName * adding location to 202 results * fixing 202 response location * renaming files * updating files with new controller name + correct entity name * fixing readme * Dev brandong getrestorabledropped (#14129) * Update RestorableDroppedDatabases API to add BackupStorageAccountType property * Update readme.md * Re-add elasticPoolId as a deprecated property * Update elasticPoolId description and remove trailing comma causing failures * Remove the unsupported deprecated property * Add 2021-02-01-preview minor changes (#13942) * add 2021-02-01-preview for test * update with 2021-04-19 latest * update readme.md * update with latest master in DSMainDev * Carry IsInfraEncryptionEnabled to Database.json (#14322) * carry latest minor changes. * re-format readme.md * remove 2020 11 01 RestorableDroppedManagedDatabases in V5 * Update readme file in 2021 02 01 dev branch to match the master branch (#14336) * Carry IsInfraEncryptionEnabled to Database.json (#14322) * carry latest minor changes. * re-format readme.md * remove 2020 11 01 RestorableDroppedManagedDatabases in V5 * update to match master branch readme.md Co-authored-by: Vineet Mahadik <[email protected]> Co-authored-by: Vineet Mahadik <[email protected]> Co-authored-by: rewongmicrosoft <[email protected]> Co-authored-by: brandong-ms <[email protected]> Co-authored-by: Arthur Ning <[email protected]>
11 tasks
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Adds base for updating Microsoft.Sql from version preview/2020-11-01-preview to version 2021-02-01-preview * Updates readme * Updates API version in new specs and examples * Fix Integer format: S360 swagger lint issues in 2021-02-01 (Azure#13855) * Update integer format * update typo * Swagger Documentation for Outbound Firewall Rules (Azure#13820) * Swagger Documentation for Outbound Firewall Rules * Add the new file to v5 Co-authored-by: Vineet Mahadik <[email protected]> * Swagger Documentation For Database Resource With Ledger (Azure#13916) * adding database swagger files * modifying example * Fixing to be boolean * adding database extensions and database operations * adding other database examples * removing database_legacy, adding usages * removing usages * removing databases_legacy from readme * Swagger Documentation For Ledger Digest Upload (Azure#13871) * adding ledger api * Fixes from validation * removing required endpoint parameter, adding ledgerName (current) to id * removing 201 response from resource, renaming ledgerName * adding location to 202 results * fixing 202 response location * renaming files * updating files with new controller name + correct entity name * fixing readme * Dev brandong getrestorabledropped (Azure#14129) * Update RestorableDroppedDatabases API to add BackupStorageAccountType property * Update readme.md * Re-add elasticPoolId as a deprecated property * Update elasticPoolId description and remove trailing comma causing failures * Remove the unsupported deprecated property * Add 2021-02-01-preview minor changes (Azure#13942) * add 2021-02-01-preview for test * update with 2021-04-19 latest * update readme.md * update with latest master in DSMainDev * Carry IsInfraEncryptionEnabled to Database.json (Azure#14322) * carry latest minor changes. * re-format readme.md * remove 2020 11 01 RestorableDroppedManagedDatabases in V5 * Update readme file in 2021 02 01 dev branch to match the master branch (Azure#14336) * Carry IsInfraEncryptionEnabled to Database.json (Azure#14322) * carry latest minor changes. * re-format readme.md * remove 2020 11 01 RestorableDroppedManagedDatabases in V5 * update to match master branch readme.md Co-authored-by: Vineet Mahadik <[email protected]> Co-authored-by: Vineet Mahadik <[email protected]> Co-authored-by: rewongmicrosoft <[email protected]> Co-authored-by: brandong-ms <[email protected]> Co-authored-by: Arthur Ning <[email protected]>
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.