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

Add single node cluster examples and update description for Cosmos DB for PostgreSQL #24256

Merged
merged 6 commits into from
Jun 19, 2023

Conversation

senatol
Copy link
Member

@senatol senatol commented Jun 1, 2023

ARM API Information (Control Plane)

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
    • Other, please clarify
  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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • 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. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
  • 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @senatol 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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 1, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    postgresqlhsc.json 2022-11-08(4d50e03) 2022-11-08(main)
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.1.3) new version base version
    package-2022-11-08 package-2022-11-08(4d50e03) package-2022-11-08(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L172
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L405
    PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L689
    PutResponseSchemaDescription Description of 201 response code of a PUT operation MUST include term 'create'.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L689
    PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L804
    PutResponseSchemaDescription Description of 201 response code of a PUT operation MUST include term 'create'.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L804
    PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L876
    PutResponseSchemaDescription Description of 201 response code of a PUT operation MUST include term 'create'.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L876
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1033
    PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1134
    PutResponseSchemaDescription Description of 201 response code of a PUT operation MUST include term 'create'.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1134
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1248
    LroPostReturn A LRO POST operation must have both 200 & 202 return codes.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1265
    LroPostReturn 200 response for a LRO POST operation must have a response schema specified.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1316
    LroPostReturn 200 response for a LRO POST operation must have a response schema specified.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1370
    LroPostReturn A LRO POST operation must have both 200 & 202 return codes.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1424
    OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1540
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1584
    PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1685
    PutResponseSchemaDescription Description of 201 response code of a PUT operation MUST include term 'create'.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1685
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1799
    ⚠️ AllProxyResourcesShouldHaveDelete The resource ServerConfiguration does not have a corresponding delete operation.
    Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L2474
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 1, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking



    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 29f3116. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/postgresqlhsc/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      warn	No package detected after generation
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 29f3116. 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
      cmderr	[automation_generate.sh]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.7.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.7.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-cosmosdbforpostgresql [View full logs]  [Release SDK Changes]
      info	[Changelog]   - Initial Release
    ️⚠️ azure-sdk-for-java warning [Detail]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 29f3116. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️sdk/resourcemanager/cosmosforpostgresql/armcosmosforpostgresql [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
      info	[Changelog]
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 29f3116. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 29f3116. 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] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile 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
    • ️✔️postgresqlhsc [View full logs]  [Release Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from 29f3116. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
      SSL error: syscall failure: Broken pipe
      Error: SSL error: syscall failure: Broken pipe
    • ️✔️Az.postgresqlhsc.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.postgresqlhsc.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 1, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/cosmosforpostgresql/armcosmosforpostgresql https://apiview.dev/Assemblies/Review/457d182ef7d5402b907c9549261c4098
    Java azure-resourcemanager-cosmosdbforpostgresql There is no API change compared with the previous version

    @senatol senatol changed the title Add single node cluster example for Cosmos DB for PostgreSQL Add single node cluster example and update description for Cosmos DB for PostgreSQL Jun 1, 2023
    @kazrael2119
    Copy link
    Contributor

    @senatol ,I think this pr need someone from your team review?

    @senatol senatol requested a review from mozansaka June 15, 2023 12:39
    @senatol senatol changed the title Add single node cluster example and update description for Cosmos DB for PostgreSQL Add single node cluster examples and update description for Cosmos DB for PostgreSQL Jun 15, 2023
    @kazrael2119
    Copy link
    Contributor

    @senatol ,please let me know when you want to merge this pr, thanks

    @senatol
    Copy link
    Member Author

    senatol commented Jun 19, 2023

    Hello @kazrael2119,
    I'd appreciate if we can merge the PR. Thanks

    @kazrael2119 kazrael2119 added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Jun 19, 2023
    harryli0108 pushed a commit to harryli0108/azure-rest-api-specs that referenced this pull request Jul 28, 2023
    … for PostgreSQL (Azure#24256)
    
    * Add single node cluster example
    
    * Update description for enableShardsOnCoordinator
    
    * fix prettier
    
    * Add rebalancing to custom words
    
    * Update examples
    
    * Update single node example
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants