Skip to content

Update Details property of Recommended Actions API to resolve Swagger Model Validation #31062

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.

Sign up for GitHub

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

Merged
UrosKrsticMIPerf merged 5 commits into from
Oct 23, 2024
Merged

Update Details property of Recommended Actions API to resolve Swagger Model Validation #31062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fc375a3
Fix the details properties definition to resolve a validation model e…
UrosKrsticMIPerf Oct 16, 2024
61b530b
Add also DatabaseAdvisors.json
UrosKrsticMIPerf Oct 17, 2024
b41c785
Merge branch 'release-sql-Microsoft.Sql-2024-08-01-preview' into dev/…
UrosKrsticMIPerf Oct 23, 2024
7841472
Just keep my change related to the additionalProperties
UrosKrsticMIPerf Oct 23, 2024
9ee4cb1
Update DatabaseRecomendedActionExpand.json example file
UrosKrsticMIPerf Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion ...ation/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseAdvisors.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,9 @@
"details": {
"description": "Gets additional details specific to this recommended action.",
"type": "object",
"additionalProperties": true,
"additionalProperties": {
"type": "string"
},
Copy link
Copy Markdown
Contributor

@ramoka178 ramoka178 Oct 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

@UrosKrsticMIPerf UrosKrsticMIPerf Oct 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

"readOnly": true
}
}
Expand Down
4 changes: 3 additions & 1 deletion ...resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseRecommendedActions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,9 @@
"details": {
"description": "Gets additional details specific to this recommended action.",
"type": "object",
"additionalProperties": true,
"additionalProperties": {
"type": "string"
},
Copy link
Copy Markdown
Contributor

@ramoka178 ramoka178 Oct 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

@UrosKrsticMIPerf UrosKrsticMIPerf Oct 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

"readOnly": true
}
}
Expand Down
4 changes: 3 additions & 1 deletion ...ication/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/ServerAdvisors.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,9 @@
"details": {
"description": "Gets additional details specific to this recommended action.",
"type": "object",
"additionalProperties": true,
"additionalProperties": {
"type": "string"
},
Copy link
Copy Markdown
Contributor

@ramoka178 ramoka178 Oct 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

@UrosKrsticMIPerf UrosKrsticMIPerf Oct 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

"readOnly": true
}
}
Expand Down
4 changes: 2 additions & 2 deletions ...icrosoft.Sql/preview/2024-08-01-preview/examples/DatabaseRecommendedActionListExpand.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,9 +597,9 @@
"observedImpact": [],
"timeSeries": [],
"details": {
"sqlErrorNumber": 208,
"sqlErrorNumber": "208",
"sqlErrorMessage": "Invalid object name 'dbo.Companies'.",
"sqlErrorCount": 342482
"sqlErrorCount": "342482"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions .../Microsoft.Sql/preview/2024-08-01-preview/examples/ServerRecommendedActionListExpand.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,9 +597,9 @@
"observedImpact": [],
"timeSeries": [],
"details": {
"sqlErrorNumber": 208,
"sqlErrorNumber": "208",
"sqlErrorMessage": "Invalid object name 'dbo.Companies'.",
"sqlErrorCount": 342482,
"sqlErrorCount": "342482",
"databaseName": "IndexAdvisor_test_3"
}
}
Expand Down