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

Managed by tenant approvers #14422

Merged
merged 3 commits into from
May 18, 2021
Merged

Managed by tenant approvers #14422

merged 3 commits into from
May 18, 2021

Conversation

skayani
Copy link
Contributor

@skayani skayani commented May 14, 2021

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. - Still in private preview
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet. - May or June 2021
  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, @skayani 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 14, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 3 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L1094:9
    Old: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L1077:9
    ❌ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L1107:9
    Old: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L1089:9
    ❌ 1041 - AddedPropertyInResponse The new version has a new property 'managedByTenantApprovers' in response that was not found in the old version.
    New: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L1093:7
    Old: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L1076:7
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ❌ R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ManagedServices/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L539
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L576
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L688
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L744
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L859
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L540
    ⚠️ R4021 - DescriptionAndTitleMissing 'MarketplaceRegistrationDefinition' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L857
    ⚠️ R4024 - PreviewVersionOverOneYear The API version:2020-02-01-preview having been in a preview state over one year , please move it to GA or retire.
    Location: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L5
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Registration Definitions
    Location: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L418
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Registration Definitions
    Location: Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json#L496
    ️️✔️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

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"managedservices/resource-manager/readme.md",
    "tag":"package-2020-02-preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"managedservices/resource-manager/readme.md",
    "tag":"package-2020-02-preview",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"managedservices/resource-manager/readme.md",
    "tag":"package-2020-02-preview",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[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-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 May 14, 2021 •
    edited
    Loading

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @openapi-workflow-bot
    Copy link

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

    This was referenced May 14, 2021
    Closed
    Closed
    Closed
    Closed
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label May 17, 2021
    dramuy
    dramuy reviewed May 17, 2021
    View reviewed changes
    ...s/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json
    @@ -1084,12 +1101,21 @@
    "x-ms-enum": {
    "name": "MultiFactorAuthProvider",
    "modelAsString": true
    }
    },
    "default": "None"
    Copy link
    Contributor

    @dramuy dramuy May 17, 2021 •
    edited
    Loading

    Choose a reason for hiding this comment

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

    "default": "None"

    thank you for fixing the default. appreciate it. #Resolved

    dramuy
    dramuy approved these changes May 17, 2021
    View reviewed changes
    Copy link
    Contributor

    @dramuy dramuy left a comment

    Choose a reason for hiding this comment

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

    :shipit:

    @skayani
    Copy link
    Contributor Author

    skayani commented May 17, 2021

    @leni-msft Hi Lei, I see you are the reviewer assigned to this PR. Since we've received breaking changes approval, we can go ahead with merging if no issues on your end.

    @leniatgh leniatgh merged commit e73179c into Azure:master May 18, 2021
    This was referenced May 18, 2021
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    @heaths heaths mentioned this pull request Jun 16, 2021
    Merged
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    @skayani @mkarmark
    Managed by tenant approvers (Azure#14422)
    96e2e4f 
    * Add managedByTenantApprovers to Swagger

* Formatting fixes

* Small fix
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @JeffreyRichter JeffreyRichter JeffreyRichter approved these changes

    @dramuy dramuy dramuy approved these changes

    Assignees

    @leniatgh leniatgh

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

    Successfully merging this pull request may close these issues.
    4 participants
    @skayani @JeffreyRichter @dramuy @leniatgh