Skip to content
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

Jump to bottom

Fix tag sql #16800

Closed
wants to merge 6 commits into from
Closed

Fix tag sql #16800

wants to merge 6 commits into from

Conversation

ankhyk
Copy link
Contributor

@ankhyk ankhyk commented Nov 18, 2021 •
edited
Loading

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:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • fix example issue for ring0 RP control plane swaggers under default tag
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] 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.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

@ankhyk ankhyk requested a review from ericshape as a code owner November 18, 2021 06:40
@openapi-workflow-bot
Copy link

Hi, @KeYu-AnkhSpirit Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

    [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 ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Nov 18, 2021
    @ghost
    Copy link

    ghost commented Nov 18, 2021

    Thank you for your contribution KeYu-AnkhSpirit! We will review the pull request and get back to you soon.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 18, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.

    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    ❌ R2020 - RequiredPropertiesMissingInResourceModel 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/2020-11-01-preview/FirewallRules.json#L308
    ❌ R2020 - RequiredPropertiesMissingInResourceModel 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/2020-11-01-preview/FirewallRules.json#L298
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'BackupShortTermRetentionPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/BackupShortTermRetentionPolicies.json#L20
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'ExtendedDatabaseBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/BlobAuditing.json#L20
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'ExtendedServerBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/BlobAuditing.json#L174
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'ServerBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/BlobAuditing.json#L314
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/BlobAuditing.json#L454
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DataWarehouseUserActivities_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/DataWarehouseUserActivities.json#L20
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseAdvisors_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/DatabaseAdvisors.json#L75
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseAutomaticTuning_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/DatabaseAutomaticTuning.json#L20
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseColumns_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/DatabaseColumns.json#L182
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseRecommendedActions_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/DatabaseRecommendedActions.json#L72
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseSchemas_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/DatabaseSchemas.json#L73
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseTables_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/DatabaseTables.json#L80
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseVulnerabilityAssessmentRuleBaselines_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/DatabaseVulnerabilityAssesmentRuleBaselines.json#L20
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseVulnerabilityAssessmentScans_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/DatabaseVulnerabilityAssessmentScans.json#L143
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseVulnerabilityAssessments_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/DatabaseVulnerabilityAssessments.json#L20
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'Databases_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/Databases_legacy.json#L62
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DeletedServers_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/DeletedServers.json#L56
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'ElasticPools_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/ElasticPools.json#L69
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'EncryptionProtectors_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/EncryptionProtectors.json#L62
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'FailoverGroups_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/FailoverGroups.json#L20
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'FirewallRules_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/FirewallRules.json#L20
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'InstanceFailoverGroups_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/InstanceFailoverGroups.json#L20
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'InstancePools_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/InstancePools.json#L20
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'JobAgents_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/JobAgents.json#L62
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'JobCredentials_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/JobCredentials.json#L69
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'JobExecutions_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/JobExecutions.json#L349
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'JobStepExecutions_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/JobStepExecutions.json#L137
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'JobSteps_GetByVersion' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2020-11-01-preview/JobSteps.json#L84
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION 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-v5
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️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.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation

    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand] 
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 18, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️❌SDK Breaking Change Tracking failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-net failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-python-track2 warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-java warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-resource-manager-schemas warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the SQL label Nov 18, 2021
    This was referenced Nov 18, 2021
    Draft
    Draft
    This was referenced Nov 18, 2021
    Draft
    Draft
    This was referenced Nov 18, 2021
    Draft
    Draft
    ericshape
    ericshape requested changes Nov 19, 2021
    View reviewed changes
    Copy link
    Contributor

    @ericshape ericshape left a comment

    Choose a reason for hiding this comment

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

    please provide a valid reason for this PR change. I cannot find any hint in the PR description.

    ...l/resource-manager/Microsoft.Sql/preview/2020-11-01-preview/examples/CancelJobExecution.json
    @@ -5,7 +5,7 @@
    "serverName": "server1",
    "jobAgentName": "agent1",
    "jobName": "job1",
    "jobExecutionId": "5555-6666-7777-8888-999999999999",
    "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
    Copy link
    Contributor

    @ericshape ericshape Nov 19, 2021 •
    edited
    Loading

    Choose a reason for hiding this comment

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

    do we know why we change it? it seems the UUID needs 128 bits?
    can you also help to modify all the cases in 2021-02-01-preview and 2021-05-01-preivew? Thanks!
    All the example files are auto-generated. Thus, we will change it in the upstream SQL repo.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    my purpose is to fix example issue for ring0 RP control plane swaggers under default tag
    in this example, it report INVALID_FORMAT error about format uuid: 5555-6666-7777-8888-999999999999

    Copy link
    Member

    Choose a reason for hiding this comment

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

    @ericshape , should we update examples here then you help apply these changes in the ADO repo coz we don't have auto-sync in place yet?

    ...n/sql/resource-manager/Microsoft.Sql/preview/2020-11-01-preview/examples/ListOperations.json
    {
    "parameters": {
    "api-version": "2020-11-01-preview"
    },
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    do we know why we need to add this example file to 2020-11-01-preview?

    all the swagger/example files in SQL are auto-generated from DSMainDev repo since 2020-02-02-preview. Manually updating would break our auto-pipeline. It means this example file needs to update for all the versions after 2020-02-02-preview.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    I find 2020-11-01-preview in default tag

    ``` yaml $(tag) == 'package-composite-v5'
input-file:
- Microsoft.Sql/stable/2014-04-01-legacy/backups_legacy.json
- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json
- Microsoft.Sql/stable/2014-04-01/dataMasking.json
- Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json
- Microsoft.Sql/stable/2014-04-01/metrics.json
- Microsoft.Sql/stable/2014-04-01-legacy/replicationLinks_legacy.json
- Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json
- Microsoft.Sql/stable/2014-04-01/serviceObjectives.json
- Microsoft.Sql/stable/2014-04-01-legacy/sql.core_legacy.json
- Microsoft.Sql/stable/2014-04-01-legacy/usages_legacy.json
- ./Microsoft.Sql/preview/2020-11-01-preview/BlobAuditing.json
- ./Microsoft.Sql/preview/2020-11-01-preview/DatabaseAdvisors.json
- ./Microsoft.Sql/preview/2020-11-01-preview/DatabaseAutomaticTuning.json
- ./Microsoft.Sql/preview/2020-11-01-preview/DatabaseColumns.json
- ./Microsoft.Sql/preview/2020-11-01-preview/DatabaseRecommendedActions.json

    if these are auto-generated, maybe i should revert them

    @zhenglaizhang
    Copy link
    Contributor

    Hi @KeYu-AnkhSpirit could you help link your GitHub account with Microsoft account by https://repos.opensource.microsoft.com/ ?

    @ericshape
    Copy link
    Contributor

    @KeYu-AnkhSpirit I am changing the upstreaming repo and generating the swagger to address the issue in c5735aa

    @ghost
    Copy link

    ghost commented Dec 26, 2021

    Hi, @KeYu-AnkhSpirit. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost
    Copy link

    ghost commented Jan 16, 2022

    Hi, @KeYu-AnkhSpirit. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Jan 16, 2022
    @ghost ghost closed this Feb 1, 2022
    @ghost
    Copy link

    ghost commented Feb 1, 2022

    Hi, @KeYu-AnkhSpirit. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    @raych1 raych1 added the FixSwaggerExample PR includes swagger example fix label Mar 30, 2022
    @ghost ghost removed the no-recent-activity label Mar 30, 2022
    This pull request was closed.
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @raych1 raych1 raych1 left review comments

    @ericshape ericshape ericshape requested changes

    Assignees

    @zhenglaizhang zhenglaizhang

    Labels
    CI-BreakingChange-Go CI-BreakingChange-Go-V2 customer-reported Issues that are reported by GitHub users external to the Azure organization. FixSwaggerExample PR includes swagger example fix SQL
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    4 participants
    @ankhyk @zhenglaizhang @ericshape @raych1