Skip to content

Conversation

@a-santamaria
Copy link
Member

@a-santamaria a-santamaria commented Apr 15, 2021

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Fixing API version 2020_05_01 we have not made this API version available yet. Fixing enums with "modelAsString": false so that sdks use enums and adding missing values

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, @a-santamaria 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 Apr 15, 2021

    Swagger Validation Report

    ️❌BreakingChange: 11 Errors, 0 Warnings failed [Detail]

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

    Rule Message
    1026 - TypeChanged The new version has a different type 'array' than the previous one ''.
    New: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedcluster.json#L442:13
    Old: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedcluster.json#L442:13
    1026 - TypeChanged The new version has a different type 'array' than the previous one ''.
    New: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedcluster.json#L485:13
    Old: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedcluster.json#L485:13
    1026 - TypeChanged The new version has a different type 'array' than the previous one ''.
    New: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedcluster.json#L781:5
    Old: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedcluster.json#L781:5
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'dropSourceReplicaOnMove' renamed or removed?
    New: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedapplication.json#L2388:7
    Old: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedapplication.json#L2383:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'codeVersion' renamed or removed?
    New: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedcluster.json#L972:7
    Old: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedcluster.json#L976:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'value' renamed or removed?
    Old: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedcluster.json#L782:7
    1034 - AddedRequiredProperty The new version has new required property 'useOnlyPrimaryLoad' that was not found in the old version.
    New: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedapplication.json#L1465:7
    Old: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedapplication.json#L1464:7
    1034 - AddedRequiredProperty The new version has new required property 'useOnlyPrimaryLoad' that was not found in the old version.
    New: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedapplication.json#L1446:5
    Old: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedapplication.json#L1446:5
    1041 - AddedPropertyInResponse The new version has a new property 'clusterCodeVersion' in response that was not found in the old version.
    New: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedcluster.json#L972:7
    Old: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedcluster.json#L976:7
    1041 - AddedPropertyInResponse The new version has a new property 'multiplePlacementGroups' in response that was not found in the old version.
    New: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/nodetype.json#L586:7
    Old: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/nodetype.json#L586:7
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ServiceFabricManagedClusters/stable/2021-05-01/managedapplication.json#L2169
    ️️✔️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 BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️[Staging] SDK Track2 Validation: 0 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:

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


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"Schema 'AddRemoveIncrementalNamedPartitionScalingMechanism' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"Schema 'AveragePartitionLoadScalingTrigger' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"Schema 'AverageServiceLoadScalingTrigger' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"Schema 'NamedPartitionScheme' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"Schema 'PartitionInstanceCountScaleMechanism' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"Schema 'ServicePlacementInvalidDomainPolicy' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"Schema 'ServicePlacementPreferPrimaryDomainPolicy' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"Schema 'ServicePlacementRequiredDomainPolicy' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"Schema 'ServicePlacementRequireDomainDistributionPolicy' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"Schema 'UniformInt64RangePartitionScheme' has an allOf list with an empty object schema as a parent,
    removing it."
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 15, 2021

    Swagger Generation Artifacts

    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1b38cd3. 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 read-shrinkwrap This version of npm is compatible with lockfileVersion@1, but package-lock.json was generated for lockfileVersion@2. I'll try to do my best with it!
      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
      warn	No file changes detected after generation
      warn	Skip detect changed packages
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1b38cd3. 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
    • ️✔️track2_azure-mgmt-servicefabricmanagedclusters [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model LoadBalancingRule has a new parameter probe_port
      info	[Changelog]   - Model NodeType has a new parameter multiple_placement_groups
      info	[Changelog]   - Model NodeType has a new parameter data_disk_type
      info	[Changelog]   - Model NodeType has a new parameter is_stateless
      info	[Changelog]   - Model ManagedCluster has a new parameter zonal_resiliency
      info	[Changelog]   - Model ManagedCluster has a new parameter cluster_upgrade_mode
      info	[Changelog]   - Added operation group ManagedClusterVersionOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model StatefulServiceProperties no longer has parameter drop_source_replica_on_move
      info	[Changelog]   - Model StatefulServiceProperties no longer has parameter service_dns_name
      info	[Changelog]   - Model StatelessServiceProperties no longer has parameter service_dns_name
      info	[Changelog]   - Model StatelessServiceProperties no longer has parameter instance_close_delay_duration
      info	[Changelog]   - Model ServiceResourceProperties no longer has parameter service_dns_name
      info	[Changelog]   - Model AverageServiceLoadScalingTrigger has a new required parameter use_only_primary_load
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @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 @a-santamaria, 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.

    @a-santamaria
    Copy link
    Member Author

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

    @chunyu3 we have not made this version available yet. we merged this api initially 2 days ago here #13860 but realize we should be using "modelAsString": false in some properties. Can we bypass this check?

    @openapi-workflow-bot
    Copy link

    Hi @a-santamaria, 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."

    @a-santamaria a-santamaria force-pushed the sfrp_managedclusters_2020-05-01_fix branch from e576256 to f1a30bc Compare April 16, 2021 04:09
    @a-santamaria
    Copy link
    Member Author

    intake created here to approve breaking change: https://msazure.visualstudio.com/One/_workitems/edit/9744666

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Apr 19, 2021
    @a-santamaria
    Copy link
    Member Author

    a-santamaria commented Apr 19, 2021

    @chunyu3 the breaking change has been approved, can you please merge the PR?

    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