Swagger changes for retention policy properties #15986
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
added 2 commits
September 9, 2021 14:10
Changes: * Updated examples and swagger json for sql database
Changes: * Updated examples and swagger json for sql database
|
Hi, @hmansari 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. vsswagger@microsoft.com |
|
[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. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version has a new property 'dataRetention' in response that was not found in the old version. New: Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json#L279:7 Old: Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json#L279:7 |
|
The new version has a new optional property 'dataRetention' that was not found in the old version. New: Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json#L279:7 Old: Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json#L279:7 |
️⚠️LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
| Rule | Message |
|---|---|
| The enum types should have x-ms-enum type extension set with appropriate options. Property name: createdByType Location: synapse/common/v1/types.json#L69 |
|
| The enum types should have x-ms-enum type extension set with appropriate options. Property name: lastModifiedByType Location: synapse/common/v1/types.json#L91 |
|
| Guid used in model definition 'SqlPoolProperties' for property 'sqlPoolGuid'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json#L395 |
|
| Guid used in model definition 'SqlDatabaseProperties' for property 'databaseGuid'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json#L320 |
|
| The API version:2020-04-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Synapse/preview/2020-04-01-preview/operations.json#L4 |
|
| The API version:2020-04-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json#L4 |
|
| The API version:2020-04-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json#L4 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/synapse/resource-manager/readme.md tag: specification/synapse/resource-manager/readme.md#tag-package-composite-v1 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
ghost
added
the
Swagger Generation Artifacts
|
…ithub.com/hmansari/azure-rest-api-specs into dev/hansari/RetentionPolicySwaggerChanges
|
Hi @hmansari, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Sep 9, 2021
ruowan
reviewed
Sep 13, 2021
| }, | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" | ||
| "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" |
There was a problem hiding this comment.
Why do you change this reference? reference to common-types is best practise
|
NewApiVersionRequired reason: |
This was referenced Sep 13, 2021
idear1203
approved these changes
Sep 15, 2021
| "type": "string", | ||
| "readOnly": true, | ||
| "x-ms-enum": { | ||
| "name": "DatabaseStatus", |
There was a problem hiding this comment.
Nice to rename as SqlDatabaseStatus because we also have Kusto database..
JeffreyRichter
added
the
Approved-BreakingChange
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
This was referenced Sep 17, 2021
Hardell
pushed a commit
to Hardell/azure-rest-api-specs
that referenced
this pull request
Sep 27, 2021
* Swagger changes for retention policy properties Changes: * Updated examples and swagger json for sql database * Swagger changes for retention policy properties Changes: * Updated examples and swagger json for sql database * addressed comment to fix ref * fixed model validation Co-authored-by: Haris Mahmood Ansari <hansari@microsoft.com>
LeiWang3
pushed a commit
to LeiWang3/azure-rest-api-specs
that referenced
this pull request
Mar 31, 2022
* Swagger changes for retention policy properties Changes: * Updated examples and swagger json for sql database * Swagger changes for retention policy properties Changes: * Updated examples and swagger json for sql database * addressed comment to fix ref * fixed model validation Co-authored-by: Haris Mahmood Ansari <hansari@microsoft.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.
Changes:
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
update existing version in preview to update swagger
It's in preview. To be avaliable in Gen3
N/A
Contribution checklist:
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 label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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 any of the following scenarios apply to the PR, request approval from the 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.