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

Fixing S360 #19554

Merged
merged 2 commits into from
Jun 30, 2022
Merged

Fixing S360 #19554

merged 2 commits into from
Jun 30, 2022

Conversation

gaoyp830
Copy link
Contributor

@gaoyp830 gaoyp830 commented Jun 21, 2022

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

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, @gaoyp830 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 21, 2022

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    1041 - AddedPropertyInResponse The new version has a new property 'benefitStartTime' in response that was not found in the old version.
    New: Microsoft.Capacity/preview/2019-04-01/reservations.json#L1228:7
    Old: Microsoft.Capacity/preview/2019-04-01/reservations.json#L1223:7
    1041 - AddedPropertyInResponse The new version has a new property 'benefitStartTime' in response that was not found in the old version.
    New: Microsoft.Capacity/preview/2019-04-01/reservations.json#L1039:7
    Old: Microsoft.Capacity/preview/2019-04-01/reservations.json#L1039:7
    ️️✔️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]
    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Capacity/preview/2019-04-01/reservations.json#L915
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Capacity/preview/2019-04-01/reservations.json#L1097
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Capacity/preview/2019-04-01/reservations.json#L1467
    R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.Capacity/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.Capacity/preview/2019-04-01/reservations.json#L671
    R4039 - ParametersOrder The parameters:reservationId,reservationOrderId should be kept in the same order as they present in the path.
    Location: Microsoft.Capacity/preview/2019-04-01/reservations.json#L466
    R4039 - ParametersOrder The parameters:reservationId,reservationOrderId should be kept in the same order as they present in the path.
    Location: Microsoft.Capacity/preview/2019-04-01/reservations.json#L555
    R4039 - ParametersOrder The parameters:reservationId,reservationOrderId should be kept in the same order as they present in the path.
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L487
    R4039 - ParametersOrder The parameters:reservationId,reservationOrderId should be kept in the same order as they present in the path.
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L576
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/preview/2019-04-01/reservations.json#L849
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/preview/2019-04-01/reservations.json#L856
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/preview/2019-04-01/reservations.json#L1029
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/preview/2019-04-01/reservations.json#L1218
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/preview/2019-04-01/reservations.json#L1646
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/preview/2019-04-01/reservations.json#L1747
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1091
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1098
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1210
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1229
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1246
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1400
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1614
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1835
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1842
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1871
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1878
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L1894
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2107
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2464
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Capacity/stable/2022-03-01/reservations.json#L2679
    ⚠️ R1003 - ListInOperationName Since operation 'ReservationOrder_ChangeDirectory' response has model definition 'array', 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.Capacity/stable/2022-03-01/reservations.json#L852
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/reservations/resource-manager/readme.md
    tag: specification/reservations/resource-manager/readme.md#tag-package-2022-03
    ️️✔️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: 4 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ IgnoredPropertyNextToRef "readme":"reservations/resource-manager/readme.md",
    "tag":"package-2022-03",
    "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > Catalog > properties > msrp > properties > p1Y)\n keys: [ \u001b[32m'type'\u001b[39m ]"
    ⚠️ IgnoredPropertyNextToRef "readme":"reservations/resource-manager/readme.md",
    "tag":"package-2022-03",
    "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ReservationsListResult > properties > summary)\n keys: [ \u001b[32m'type'\u001b[39m ]"
    ⚠️ IgnoredPropertyNextToRef "readme":"reservations/resource-manager/readme.md",
    "tag":"package-2022-03",
    "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > QuotaRequestSubmitResponse > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]"
    ⚠️ IgnoredPropertyNextToRef "readme":"reservations/resource-manager/readme.md",
    "tag":"package-preview-2019-07-19",
    "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > QuotaRequestSubmitResponse > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]"
    💬 "readme":"reservations/resource-manager/readme.md",
    "tag":"package-2022-03",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)"
    💬 "readme":"reservations/resource-manager/readme.md",
    "tag":"package-2022-03",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"
    💬 "readme":"reservations/resource-manager/readme.md",
    "tag":"package-2022-03",
    "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)"
    💬 "readme":"reservations/resource-manager/readme.md",
    "tag":"package-2022-03",
    "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"
    💬 "readme":"reservations/resource-manager/readme.md",
    "tag":"package-2022-03",
    "details":"Autorest completed in 13.28s. 0 files generated."
    💬 "readme":"reservations/resource-manager/readme.md",
    "tag":"package-preview-2019-07-19",
    "details":"Autorest completed in 4.44s. 0 files generated."
    💬 "readme":"reservations/resource-manager/readme.md",
    "tag":"package-preview-2019-04",
    "details":"Autorest completed in 3.67s. 0 files generated."


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: |"readme":"reservations/resource-manager/readme.md",
    "tag":"package-2022-03",
    "details":"AutoRest core version selected from configuration: ^3.2.0."|
    |:speech_balloon: |"readme":"reservations/resource-manager/readme.md",
    "tag":"package-preview-2019-07-19",
    "details":"AutoRest core version selected from configuration: ^3.2.0."|
    |:speech_balloon: |"readme":"reservations/resource-manager/readme.md",
    "tag":"package-preview-2019-07-19",
    "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"|
    |:speech_balloon: |"readme":"reservations/resource-manager/readme.md",
    "tag":"package-preview-2019-07-19",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"|
    |:speech_balloon: |"readme":"reservations/resource-manager/readme.md",
    "tag":"package-preview-2019-04",
    "details":"AutoRest core version selected from configuration: ^3.2.0."|
    |:speech_balloon: |"readme":"reservations/resource-manager/readme.md",
    "tag":"package-preview-2019-04",
    "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"|
    |:speech_balloon: |"readme":"reservations/resource-manager/readme.md",
    "tag":"package-preview-2019-04",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"|

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 21, 2022

    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-go - armreservations - 1.0.1
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-reservations - 2.0.0
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 01f2d2f. 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]  global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-reservations [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 01f2d2f. 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
    • ️✔️armreservations [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 01f2d2f. 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
      cmderr	[automation_init.sh]  WARN deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh] deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh]  deprecated @azure/[email protected]: This version has been deprecated, please upgrade to the version tagged as latest
      cmderr	[automation_init.sh]  @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      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
    • ️✔️@azure/arm-reservations [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 01f2d2f. 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
      warn	No file changes detected after generation
    • ️✔️reservations [View full logs
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 01f2d2f. 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.ReservationApi [View full logs]  [Release SDK Changes]
    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.

    @lirenhe
    Copy link
    Member

    lirenhe commented Jun 22, 2022

    @gaoyp830, adding new property into the existing version is a breaking change so please follow the below process to get it reviewed.

    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.

    @gaoyp830
    Copy link
    Contributor Author

    @gaoyp830, adding new property into the existing version is a breaking change so please follow the below process to get it reviewed.

    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.

    @lirenhe Created intake form https://msazure.visualstudio.com/One/_workitems/edit/14818788/

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jun 29, 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 FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants