Update Details property of Recommended Actions API to resolve Swagger Model Validation by UrosKrsticMIPerf · Pull Request #31062 · Azure/azure-rest-api-specs

UrosKrsticMIPerf · 2024-10-16T18:52:44Z

…rror

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

New resource provider.
New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix OpenAPI spec quality issues in S360.
Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
Other, please clarify:
- updating one property to resolve a swagger model validation error related to this check: https://github.com/Azure/azure-rest-api-specs/pull/30030/checks?check_run_id=28134711114

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:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
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 ApiView comment 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
suppressions guide to get approval.

Getting help

First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

…rror

openapi-pipeline-app · 2024-10-16T18:52:48Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

openapi-pipeline-app · 2024-10-16T18:52:49Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/sql/armsql	There is no API change compared with the previous version
JavaScript	@azure/arm-sql	There is no API change compared with the previous version
.Net	Azure.ResourceManager.Sql	https://apiview.dev/Assemblies/Review/1e3ea1e2dc2c4679b3acd45b20b81a18?revisionId=546dba2cdc8d4eaeab9bfd041e67f17f
Swagger	Microsoft.Sql	https://apiview.dev/Assemblies/Review/86f9467cec6a49f899d90b4872280851?revisionId=b2e34c216a8f4f76aa3b2c0c7f60f1d3

specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAdvisors.json

...fication/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseAdvisors.json

ramoka178 · 2024-10-22T22:21:40Z

...fication/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseAdvisors.json

+          "description": "Resource type.",
+          "type": "string",
+          "readOnly": true
+        }


it was referring to common-types ProxyResource. Why to remove now as that is the suggested way

...fication/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseAdvisors.json

ramoka178 · 2024-10-22T22:21:52Z

specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAdvisors.json

-          "additionalProperties": true,
+          "additionalProperties": {
+            "type": "string"
+          },


Use of additionalProperties is not allowed for properties owned by the service. The only time its ok to use it is when the properties are pass thru (user defined) and not subject to any validations. Please make this an array or provide an explanation for why you need this.

This has been used since the inception of the service, additionalProperties is already being used and has been for the last 9 years, I just wanted to fix the ModelValidation error, as the SQL ARM API team asked me to do that.

ramoka178 · 2024-10-22T22:21:54Z

...ql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseRecommendedActions.json

-          "additionalProperties": true,
+          "additionalProperties": {
+            "type": "string"
+          },


Use of additionalProperties is not allowed for properties owned by the service. The only time its ok to use it is when the properties are pass thru (user defined) and not subject to any validations. Please make this an array or provide an explanation for why you need this.

This has been used since the inception of the service, additionalProperties is already being used and has been for the last 9 years, I just wanted to fix the ModelValidation error, as the SQL ARM API team asked me to do that.

ramoka178 · 2024-10-22T22:21:57Z

...fication/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseAdvisors.json

-          "additionalProperties": true,
+          "additionalProperties": {
+            "type": "string"
+          },


Use of additionalProperties is not allowed for properties owned by the service. The only time its ok to use it is when the properties are pass thru (user defined) and not subject to any validations. Please make this an array or provide an explanation for why you need this.

This has been used since the inception of the service, additionalProperties is already being used and has been for the last 9 years, I just wanted to fix the ModelValidation error, as the SQL ARM API team asked me to do that.

ramoka178 · 2024-10-22T22:22:39Z

Swagger ModelValidation is still failing as this PR aimed to solve such errors. Please fix these too.

…uroskrstic/fix-database-recommended-action-swagger

UrosKrsticMIPerf · 2024-10-23T13:47:00Z

Swagger ModelValidation is still failing as this PR aimed to solve such errors. Please fix these too.

ModelValidation passing now, the rest of changes are not part of my PR and my code change so they have been reverted.

ramoka178 · 2024-10-23T19:16:09Z

Approving as these are existing ones

* adding MemorySizeInGb to swagger #30912 * adding #31080 and #31062 * prettier fix * prettiercheck fix

Fix the details properties definition to resolve a validation model e…

fc375a3

…rror

UrosKrsticMIPerf requested review from ericshape, jamestao and jeremyfrosti as code owners October 16, 2024 18:52

microsoft-github-policy-service bot added the SQL label Oct 16, 2024

azure-sdk mentioned this pull request Oct 16, 2024

[AutoPR sdk/resourcemanager/sql/armsql] Update Details property of Recommended Actions API to resolve Swagger Model Validation azure-sdk/azure-sdk-for-go#11860

Closed

AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 16, 2024

ericshape reviewed Oct 16, 2024

View reviewed changes

specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAdvisors.json Show resolved Hide resolved

Add also DatabaseAdvisors.json

61b530b

ericshape approved these changes Oct 18, 2024

View reviewed changes

ramoka178 reviewed Oct 22, 2024

View reviewed changes

...fication/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseAdvisors.json Outdated Show resolved Hide resolved

ramoka178 reviewed Oct 22, 2024

View reviewed changes

...fication/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseAdvisors.json Outdated Show resolved Hide resolved

ramoka178 reviewed Oct 22, 2024

View reviewed changes

ramoka178 added the ARMChangesRequested label Oct 22, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 22, 2024

UrosKrsticMIPerf added 3 commits October 23, 2024 11:49

Merge branch 'release-sql-Microsoft.Sql-2024-08-01-preview' into dev/…

b41c785

…uroskrstic/fix-database-recommended-action-swagger

Just keep my change related to the additionalProperties

7841472

Update DatabaseRecomendedActionExpand.json example file

9ee4cb1

UrosKrsticMIPerf removed the ARMChangesRequested label Oct 23, 2024

openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 23, 2024

ramoka178 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 23, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 23, 2024

UrosKrsticMIPerf merged commit 4d5d694 into Azure:release-sql-Microsoft.Sql-2024-08-01-preview Oct 23, 2024

achyuth-ms mentioned this pull request Apr 9, 2025

Merging #31080 , #31062 and #30912 for new API release #33807

Merged

8 tasks

ericshape pushed a commit that referenced this pull request Apr 9, 2025

Merging #31080 , #31062 and #30912 for new API release (#33807)

17b24fe

* adding MemorySizeInGb to swagger #30912 * adding #31080 and #31062 * prettier fix * prettiercheck fix

ericshape mentioned this pull request Apr 15, 2025

Publish sql microsoft.sql 2024 08 01 preview #33936

Closed

8 tasks

Conversation

UrosKrsticMIPerf commented Oct 16, 2024

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

Uh oh!

openapi-pipeline-app bot commented Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app bot commented Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

Uh oh!

Uh oh!

ramoka178 Oct 22, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ramoka178 Oct 22, 2024

Choose a reason for hiding this comment

Uh oh!

UrosKrsticMIPerf Oct 23, 2024

Choose a reason for hiding this comment

Uh oh!

ramoka178 Oct 22, 2024

Choose a reason for hiding this comment

Uh oh!

UrosKrsticMIPerf Oct 23, 2024

Choose a reason for hiding this comment

Uh oh!

ramoka178 Oct 22, 2024

Choose a reason for hiding this comment

Uh oh!

UrosKrsticMIPerf Oct 23, 2024

Choose a reason for hiding this comment

Uh oh!

ramoka178 commented Oct 22, 2024

Uh oh!

UrosKrsticMIPerf commented Oct 23, 2024

Uh oh!

ramoka178 commented Oct 23, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

openapi-pipeline-app bot commented Oct 16, 2024 •

edited

Loading

openapi-pipeline-app bot commented Oct 16, 2024 •

edited

Loading