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

ARM ID annotations for Postgres #19595

Merged
merged 1 commit into from
Aug 5, 2022

Conversation

matthchr
Copy link
Member

Uses the new arm-id format to describe fields which are references to other ARM resources.

This was split off from #18318

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. If updating an existing version, please select the specific language 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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
  • 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.

@openapi-workflow-bot
Copy link

Hi, @matthchr 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 24, 2022

    Swagger Validation Report

    ️❌BreakingChange: 3 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.9.6)] new version base version
    postgresql.json 2021-06-01(a513da9) 2021-06-01(main)
    Rule Message
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1745:9
    Old: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1737:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1762:9
    Old: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1746:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1489:9
    Old: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1489:9
    ️️✔️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 v1.13.0) new version base version
    package-flexibleserver-2021-06 package-flexibleserver-2021-06(a513da9) package-flexibleserver-2021-06(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R4037 - MissingTypeObject The schema 'StorageEditionCapability' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1177
    R4037 - MissingTypeObject The schema 'CapabilityProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1310
    R4037 - MissingTypeObject The schema 'ServerProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1404
    R4037 - MissingTypeObject The schema 'Server' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1542
    R4037 - MissingTypeObject The schema 'ServerPropertiesForUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1566
    R4037 - MissingTypeObject The schema 'ServerForUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1618
    R4037 - MissingTypeObject The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1660
    R4037 - MissingTypeObject The schema 'Storage' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1686
    R4037 - MissingTypeObject The schema 'Backup' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1696
    R4037 - MissingTypeObject The schema 'Network' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1730
    R4037 - MissingTypeObject The schema 'HighAvailability' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1782
    R4037 - MissingTypeObject The schema 'FirewallRuleProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1851
    R4037 - MissingTypeObject The schema 'FirewallRule' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1870
    R4037 - MissingTypeObject The schema 'ConfigurationProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1910
    R4037 - MissingTypeObject The schema 'Configuration' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1978
    R4037 - MissingTypeObject The schema 'OperationDisplay' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L2015
    R4037 - MissingTypeObject The schema 'Operation' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L2040
    R4037 - MissingTypeObject The schema 'NameAvailabilityRequest' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L2103
    R4037 - MissingTypeObject The schema 'NameAvailability' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L2119
    R4037 - MissingTypeObject The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L2181
    ⚠️ R1003 - ListInOperationName Since operation 'LocationBasedCapabilitiesExecute' response has model definition 'x-ms-pageable', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L916
    ⚠️ R1005 - GetInOperationName 'GET' operation 'LocationBasedCapabilities_Execute' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L916
    ⚠️ R1006 - PutInOperationName 'PUT' operation 'Configurations_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L813
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1002
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Execute'. Consider updating the operationId
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L871
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'checkvirtualnetworksubnetusage' in:'VirtualNetworkSubnetUsage_Execute'. Consider updating the operationId
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L958
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: geoBackupSupported
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1317
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: zoneRedundantHaSupported
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1322
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: zoneRedundantHaAndGeoBackupSupported
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1327
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDynamicConfig
    Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1950
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/postgresql/resource-manager/readme.md
    tag: specification/postgresql/resource-manager/readme.md#tag-package-2020-01-01
    ️️✔️ApiReadinessCheck 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.
    ️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/a513da9f659e88de765b3cea17332ceed7dded07/specification/postgresql/resource-manager/readme.md#tag-package-flexibleserver-2021-06">postgresql/resource-manager/readme.md#package-flexibleserver-2021-06
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"postgresql/resource-manager/readme.md",
    "tag":"package-flexibleserver-2021-06",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 24, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - armpostgresql - 1.0.1
    ️✔️azure-sdk-for-go - armpostgresqlflexibleservers - 1.1.0
    azure-sdk-for-python-track2 - track2_azure-mgmt-rdbms - 10.2.0b1
    +	Model Server no longer has parameter tags_properties_tags
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a10f4b6. 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] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-rdbms [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a10f4b6. 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
    • ️✔️armpostgresql [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️armpostgresqlflexibleservers [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a10f4b6. 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 a10f4b6. 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]  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
    • ️✔️postgresql [View full logs]  [Release Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a10f4b6. 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
    • ️✔️Az.PostgreSql [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @matthchr
    Copy link
    Member Author

    .NET SDK for reference. This PR is a superset of the .NET SDK arm-ids, which should be OK because the Postgres .NET SDK isn't GA yet.

    @ArcturusZhang ArcturusZhang added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Aug 5, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants