Update Azure SQLDB 2020-02-02-preview swagger files #11840
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
Swagger Validation Report
Only 10 items are listed, please refer to log for more details.
|
| Rule | Message |
|---|---|
| Per the Noun_Verb convention for Operation Ids, the noun 'ManagedInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.Sql/preview/2020-02-02-preview/ManagedInstances.json#L302 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'ManagedInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.Sql/preview/2020-02-02-preview/ManagedInstances.json#L302 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'ManagedInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.Sql/preview/2020-02-02-preview/ManagedInstances.json#L302 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'ManagedInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.Sql/preview/2020-02-02-preview/ManagedInstances.json#L302 |
|
| Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Sql/preview/2020-02-02-preview/ManagedInstances.json#L735 |
|
| Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Sql/preview/2020-02-02-preview/ManagedInstances.json#L735 |
|
| Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Sql/preview/2020-02-02-preview/ManagedInstances.json#L735 |
|
| Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Sql/preview/2020-02-02-preview/ManagedInstances.json#L735 |
|
| 'TopQueries' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.Sql/preview/2020-02-02-preview/ManagedInstances.json#L868 |
|
| 'ManagedInstancePrivateEndpointProperty' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.Sql/preview/2020-02-02-preview/ManagedInstances.json#L761 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/sql/resource-manager/readme.md tag: specification/sql/resource-manager/readme.md#tag-package-composite-v4 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️🔄[Staging] Cross Version BreakingChange (Base on preview version) inProgress [Detail]
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
|
NewApiVersionRequired reason: |
|
Hi @ericshape, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @ericshape your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @${PRAssignee} |
|
Hi, @ericshape 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] |
ericshape
changed the title
This was referenced Dec 1, 2020
25 tasks
|
For the lintDiff failure , it's because there are model conflict among the swaggers inside the tags: package-composite-v1 to v4 , |
ericshape
commented
Dec 9, 2020
| - Microsoft.Sql/preview/2020-02-02-preview/importexport.json | ||
| - ./Microsoft.Sql/preview/2020-02-02-preview/ManagedInstanceAzureADOnlyAuthentications.json | ||
| - ./Microsoft.Sql/preview/2020-02-02-preview/ServerTrustGroups.json | ||
| - ./Microsoft.Sql/preview/2020-02-02-preview/BackupShortTermRetentionPolicies.json |
There was a problem hiding this comment.
All the newly added json files are carried from previous versions. They are NOT the new introduced API endpoints.
ericshape
commented
Dec 9, 2020
| }, | ||
| { | ||
| "$ref": "#/parameters/ManagedInstanceNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/SubscriptionIdParameter" | ||
| "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" |
There was a problem hiding this comment.
In these serverXYZ json files, we only change the common type parameters/definitions to reference and remove previous local inline parameters/definitions.
|
the failures of JS and Ruby SDK are not due to our changes. And APIDocPreview and cross-version breaking changes have been stuck over 12 hours. |
jamestao
approved these changes
Dec 10, 2020
|
comments:
Recommendation: |
bcham
approved these changes
Dec 10, 2020
|
@akning-ms |
akning-ms
removed
the
WaitForARMFeedback
This was referenced Dec 12, 2020
Closed
[ReleasePR Microsoft.Azure.Management.Sql] add sql tag to readme.go.md
Azure/azure-sdk-for-net#17306
Closed
dabenhamMic
pushed a commit
to dabenhamMic/azure-rest-api-specs
that referenced
this pull request
Dec 14, 2020
* Update 2020-02-02-preview swagger files * change common reference * Update readme.azureresourceschema.md * Attach the fix of ResourceIdentity * revert ResourceIdentity change. * remove DevOpsAudit.json
This was referenced Dec 17, 2020
Merged
giromm2ms
pushed a commit
to giromm2ms/azure-rest-api-specs
that referenced
this pull request
Dec 20, 2020
* Update 2020-02-02-preview swagger files * change common reference * Update readme.azureresourceschema.md * Attach the fix of ResourceIdentity * revert ResourceIdentity change. * remove DevOpsAudit.json
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.
Update Azure SQLDB 2020-02-02-preview swagger files.
Most of the changes (>99%) in this PR are auto-generated by SQL DB DSMainDev Repo. The manual change is only in README.md and readme.azureresourceschema.md.
This PR is a copy of an existing API-version to a preview version (2020-02-02-preview) with no API changes. Via this PR, we will address over 73 S360 Alerts about API swagger completeness and correctness.
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.
Already published
Already published
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 API Review Board as defined in the Breaking Change Policy.
The breaking change errors are not real errors.
In https://github.com/Azure/azure-rest-api-specs/pull/11840/checks?check_run_id=1465548188, after careful comparison, we can find all the deleted parameters are unused in the old swagger JSON files. Thus, we remove them in the internal DSMainDev repo.
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.