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

[CosmosDB] Fixing bugs in Services APIs #15971

Merged
merged 9 commits into from
Sep 14, 2021
Merged

[CosmosDB] Fixing bugs in Services APIs #15971

merged 9 commits into from
Sep 14, 2021

Conversation

MehaKaushik
Copy link
Contributor

@MehaKaushik MehaKaushik commented Sep 8, 2021 •
edited
Loading

This PR fixes two issues in existing APIs:

  1. The value of discriminator was not correctly assigned in the generated SDKs and docs. According to [docs](Microsoft.DocumentDB/databaseAccounts/services - Bicep & ARM template reference | Microsoft Docs) ServieType has possible values: DataTransferServiceResourceProperties, SqlDedicatedGatewayServiceResourceProperties. This is incorrect. The possible values are DataTransfer, SqlDedicatedGateway and (2021-07-01-preview onwards) GraphAPICompute. Adding x-ms-discriminator to specific subclasses, fixed the issue.
  2. The CreateUpdateParameters for Create/Update request body should look like:
    properties:{
    "name": name,
    "instanceSize": instanceSize
    }
    According to the existing specs they were missing the properties object bag. This PR fixes the same. This was affecting the generated SDKs.

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

@openapi-workflow-bot
Copy link

Hi, @MehaKaushik 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-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 Sep 8, 2021 •
    edited
    Loading

    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 Sep 8, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️⌛ azure-sdk-for-python-track2 pending [Detail]
    ️⌛ azure-sdk-for-java pending [Detail]
    ️⌛ azure-sdk-for-go pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 8, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
    ️⌛[Staging] SDK Breaking Change Tracking pending [Detail]
    ️⚠️ 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 failed [Detail]

    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?

    This was referenced Sep 8, 2021
    Closed
    Closed
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Sep 8, 2021
    Closed
    @MehaKaushik MehaKaushik marked this pull request as draft September 8, 2021 22:16
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Sep 8, 2021
    Closed
    @zhenglaizhang zhenglaizhang mentioned this pull request Sep 9, 2021
    Closed
    25 tasks
    @MehaKaushik MehaKaushik changed the title test [do not merge] test Sep 9, 2021
    @openapi-workflow-bot
    Copy link

    Hi @MehaKaushik, 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.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @openapi-workflow-bot
    Copy link

    Hi @MehaKaushik, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
     If you need further help, please feedback via swagger feedback."

    @MehaKaushik MehaKaushik changed the title [do not merge] test [CosmosDB] Fixing bugs in Services APIs Sep 10, 2021
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Sep 10, 2021
    Closed
    @MehaKaushik MehaKaushik marked this pull request as ready for review September 13, 2021 16:48
    @MehaKaushik
    Copy link
    Contributor Author

    MehaKaushik commented Sep 13, 2021 •
    edited
    Loading

    @ArcturusZhang @weidongxu-microsoft can you please have a look at this PR. I will involve the breaking change committee once I have approval on the bug fixes.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 13, 2021
    @weidongxu-microsoft
    Copy link
    Member

    @ArcturusZhang go track2 failed, do you want to take a look? If not I will go ahead to merge it.

    @tadelesh
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @weidongxu-microsoft weidongxu-microsoft merged commit 6223e02 into Azure:main Sep 14, 2021
    This was referenced Sep 14, 2021
    Closed
    Closed
    Closed
    Merged
    Closed
    Closed
    ghost pushed a commit to Azure/azure-resource-manager-schemas that referenced this pull request Sep 14, 2021
    [ReleasePR cosmos-db] [CosmosDB] Fixing bugs in Services APIs (#1903)
    f5bcb25 
    Create to sync Azure/azure-rest-api-specs#15971
[ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...AzureSDKAutomation:sdkAuto/cosmos-db?expand=1)
    @RAY-316
    Copy link
    Contributor

    RAY-316 commented Sep 14, 2021

    /azp run

    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    @MehaKaushik @LeiWang3
    [CosmosDB] Fixing bugs in Services APIs (Azure#15971)
    85e7866 
    * test

* try1

* fixing services discriminator

* prettier and readme

* revert additional changes

* fixing model validation errors

* model validation fix

* nit

Co-authored-by: Meha Kaushik <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @weidongxu-microsoft weidongxu-microsoft weidongxu-microsoft approved these changes

    @ArcturusZhang ArcturusZhang Awaiting requested review from ArcturusZhang

    Assignees

    @weidongxu-microsoft weidongxu-microsoft

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go CI-FixRequiredOnFailure FixS360
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    5 participants
    @MehaKaushik @weidongxu-microsoft @tadelesh @RAY-316 @JeffreyRichter