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.

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

[PostgreSQL] Flexible Server GA API change tag name #14859

Merged
merged 2 commits into from
Jun 21, 2021

Conversation

DaeunYim
Copy link
Contributor

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.

  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
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

  • 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.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • 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 Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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.

@openapi-workflow-bot
Copy link

Hi, @DaeunYim 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.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 17, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️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
    ️️✔️[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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 17, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
    ️⌛[Staging] SDK Breaking Change Tracking pending [Detail]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c7616be. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c7616be. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-06-24 08:52:49 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-postgresql;1.0.0;1.1.0-beta.1"
      cmderr	[generate.py] 2021-06-24 08:52:49 WARNING [VERSION][Not Implement] set to current version "1.1.0-beta.1" by default
      cmderr	[generate.py] 2021-06-24 08:52:49 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.30 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/postgresql/azure-resourcemanager-postgresql --java.namespace=com.azure.resourcemanager.postgresql   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/postgresql/resource-manager/readme.md
      cmderr	[generate.py] 2021-06-24 08:53:27 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-postgresql
      cmderr	[generate.py] 2021-06-24 08:53:27 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-06-24 08:53:27 INFO [POM][Skip] pom already has module azure-resourcemanager-postgresql
      cmderr	[generate.py] 2021-06-24 08:53:27 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-06-24 08:53:27 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-06-24 08:53:27 INFO [POM][Skip] pom already has module sdk/postgresql
      cmderr	[generate.py] 2021-06-24 08:53:27 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-postgresql [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-06-24 08:55:26 DEBUG Got artifact_id: azure-resourcemanager-postgresql
      cmderr	[Inst] 2021-06-24 08:55:26 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-06-24 08:55:26 DEBUG Got artifact: azure-resourcemanager-postgresql-1.1.0-beta.1.jar
      cmderr	[Inst] 2021-06-24 08:55:26 DEBUG Match jar package: azure-resourcemanager-postgresql-1.1.0-beta.1.jar
      cmderr	[Inst] 2021-06-24 08:55:26 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14859/azure-sdk-for-java/azure-resourcemanager-postgresql/azure-resourcemanager-postgresql-1.1.0-beta.1.jar\" -o azure-resourcemanager-postgresql-1.1.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-postgresql -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-postgresql-1.1.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c7616be. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️postgresql/mgmt/2021-06-01/postgresqlflexibleservers [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️postgresql/mgmt/2020-01-01/postgresql [View full logs
      Only show 18 items here, please refer to log for details.
      info	[Changelog] - New struct `RecoverableServerProperties`
      info	[Changelog] - New struct `RecoverableServerResource`
      info	[Changelog] - New struct `RecoverableServersClient`
      info	[Changelog] - New struct `ServerBasedPerformanceTierClient`
      info	[Changelog] - New struct `ServerParametersClient`
      info	[Changelog] - New struct `ServerParametersListUpdateConfigurationsFuture`
      info	[Changelog] - New struct `ServerSecurityAlertPolicyListResult`
      info	[Changelog] - New struct `ServerSecurityAlertPolicyListResultIterator`
      info	[Changelog] - New struct `ServerSecurityAlertPolicyListResultPage`
      info	[Changelog] - New field `MaxLargeStorageMB` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MinStorageMB` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MaxBackupRetentionDays` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MinBackupRetentionDays` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MaxStorageMB` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MinLargeStorageMB` in struct `PerformanceTierProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 60 additive change(s).
      info	[Changelog]
    • ️✔️postgresql/mgmt/2017-12-01/postgresql [View full logs
      Only show 18 items here, please refer to log for details.
      info	[Changelog] - New struct `RecoverableServerProperties`
      info	[Changelog] - New struct `RecoverableServerResource`
      info	[Changelog] - New struct `RecoverableServersClient`
      info	[Changelog] - New struct `ServerBasedPerformanceTierClient`
      info	[Changelog] - New struct `ServerParametersClient`
      info	[Changelog] - New struct `ServerParametersListUpdateConfigurationsFuture`
      info	[Changelog] - New struct `ServerSecurityAlertPolicyListResult`
      info	[Changelog] - New struct `ServerSecurityAlertPolicyListResultIterator`
      info	[Changelog] - New struct `ServerSecurityAlertPolicyListResultPage`
      info	[Changelog] - New field `MinBackupRetentionDays` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MaxStorageMB` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MinLargeStorageMB` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MaxLargeStorageMB` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MinStorageMB` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MaxBackupRetentionDays` in struct `PerformanceTierProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 60 additive change(s).
      info	[Changelog]
    • ️✔️preview/postgresql/mgmt/2021-06-01-preview/postgresqlflexibleservers [View full logs
      info	[Changelog] This is a new package
    • ️✔️preview/postgresql/mgmt/2020-11-05-preview/postgresqlflexibleservers [View full logs
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New struct `ServerPropertiesPrivateDNSZoneArguments`
      info	[Changelog] - New field `SourceSubscriptionID` in struct `ServerProperties`
      info	[Changelog] - New field `SourceResourceGroupName` in struct `ServerProperties`
      info	[Changelog] - New field `PrivateDNSZoneArguments` in struct `ServerProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 3 additive change(s).
      info	[Changelog]
    • ️✔️preview/postgresql/mgmt/2020-02-14-preview/postgresqlflexibleservers [View full logs
      info	[Changelog] No exported changes
    • ️✔️preview/postgresql/mgmt/2017-12-01-preview/postgresql [View full logs
      Only show 18 items here, please refer to log for details.
      info	[Changelog] - New struct `RecoverableServerProperties`
      info	[Changelog] - New struct `RecoverableServerResource`
      info	[Changelog] - New struct `RecoverableServersClient`
      info	[Changelog] - New struct `ServerBasedPerformanceTierClient`
      info	[Changelog] - New struct `ServerParametersClient`
      info	[Changelog] - New struct `ServerParametersListUpdateConfigurationsFuture`
      info	[Changelog] - New struct `ServerSecurityAlertPolicyListResult`
      info	[Changelog] - New struct `ServerSecurityAlertPolicyListResultIterator`
      info	[Changelog] - New struct `ServerSecurityAlertPolicyListResultPage`
      info	[Changelog] - New field `MinBackupRetentionDays` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MaxStorageMB` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MinLargeStorageMB` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MaxLargeStorageMB` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MinStorageMB` in struct `PerformanceTierProperties`
      info	[Changelog] - New field `MaxBackupRetentionDays` in struct `PerformanceTierProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 60 additive change(s).
      info	[Changelog]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c7616be. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/postgresql/resource-manager/readme.md
    • ️✔️@azure/arm-postgresql-flexible [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/postgreSQLManagementClient.js → ./dist/arm-postgresql-flexible.js...
      cmderr	[npmPack] created ./dist/arm-postgresql-flexible.js in 333ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c7616be. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh]
      cmderr	[initScript.sh]  The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh]  so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh]
      cmderr	[initScript.sh]  This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    • ️✔️postgresql [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @msyyc
    Copy link
    Member

    msyyc commented Jun 18, 2021

    Hi @DaeunYim
    For python, the configuration is very strange. Even though you configure it to multi-api, but it actually does not take effect. I advise to remould it thoroughly. You could reference ‘resources’ since it has the similar structure: https://github.com/Azure/azure-rest-api-specs/blob/master/specification/resources/resource-manager/readme.python.md

    @DaeunYim
    Copy link
    Contributor Author

    Hi @DaeunYim
    For python, the configuration is very strange. Even though you configure it to multi-api, but it actually does not take effect. I advise to remould it thoroughly. You could reference ‘resources’ since it has the similar structure: https://github.com/Azure/azure-rest-api-specs/blob/master/specification/resources/resource-manager/readme.python.md

    @msyyc Thanks, actually I don't think there'll be case we release multiple products (flexible server, single server) altogether. I think it's okay to simply remove multi api feature here and specify output folder for single/flexible server. I have updated it. Let me know if you have any other concerns.

    @leni-msft
    Copy link
    Contributor

    @ArcturusZhang @msyyc @lirenhe please help review the readme files.

    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

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

    it is fine since we are only changing the name of a tag

    @leni-msft leni-msft merged commit c7616be into Azure:master Jun 21, 2021
    @RAY-316
    Copy link
    Contributor

    RAY-316 commented Jun 24, 2021

    /azp run

    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * [PostgreSQL] Flexible Server GA API change tag name and file name
    
    * remove python multi api
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants