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

Fix Swagger Correctness. #12271

Merged
merged 4 commits into from
Feb 26, 2021
Merged

Fix Swagger Correctness. #12271

merged 4 commits into from
Feb 26, 2021

Conversation

bowen5
Copy link
Contributor

@bowen5 bowen5 commented Jan 4, 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.
  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
    • 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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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, @bowen5 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 Jan 4, 2021

    Swagger Validation Report

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

    Rule Message
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json#L2387:9
    Old: Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json#L2387:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json#L2392:9
    Old: Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json#L2391:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.AppPlatform/preview/2020-11-01-preview/appplatform.json#L2882:9
    Old: Microsoft.AppPlatform/preview/2020-11-01-preview/appplatform.json#L2882:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.AppPlatform/preview/2020-11-01-preview/appplatform.json#L2887:9
    Old: Microsoft.AppPlatform/preview/2020-11-01-preview/appplatform.json#L2886:9
    ️️✔️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.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[Staging] 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: 9 Warnings warning [Detail]

    Rule Message
    ⚠️ PreCheck/SchemaMissingType "readme":"appplatform/resource-manager/readme.md",
    "tag":"package-preview-2020-11",
    "details":"The schema 'CloudError' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"appplatform/resource-manager/readme.md",
    "tag":"package-preview-2020-11",
    "details":"The schema 'CloudErrorBody' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/CheckDuplicateSchemas "readme":"appplatform/resource-manager/readme.md",
    "tag":"package-preview-2020-11",
    "details":"Checking for duplicate schemas,
    this could take a (long) while. Run with --verbose for more detail."
    ⚠️ PreCheck/SchemaMissingType "readme":"appplatform/resource-manager/readme.md",
    "tag":"package-2020-07",
    "details":"The schema 'CloudError' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"appplatform/resource-manager/readme.md",
    "tag":"package-2020-07",
    "details":"The schema 'CloudErrorBody' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/CheckDuplicateSchemas "readme":"appplatform/resource-manager/readme.md",
    "tag":"package-2020-07",
    "details":"Checking for duplicate schemas,
    this could take a (long) while. Run with --verbose for more detail."
    ⚠️ PreCheck/SchemaMissingType "readme":"appplatform/resource-manager/readme.md",
    "tag":"package-2019-05-01-preview",
    "details":"The schema 'CloudError' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"appplatform/resource-manager/readme.md",
    "tag":"package-2019-05-01-preview",
    "details":"The schema 'CloudErrorBody' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/CheckDuplicateSchemas "readme":"appplatform/resource-manager/readme.md",
    "tag":"package-2019-05-01-preview",
    "details":"Checking for duplicate schemas,
    this could take a (long) while. Run with --verbose for more detail."
    ️️✔️[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 Jan 4, 2021

    Swagger Generation Artifacts

    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 0e18f46. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-02-26 05:57:18 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-appplatform-generated"
      cmderr	[generate.py] 2021-02-26 05:57:18 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-02-26 05:57:18 INFO autorest --version=3.0.6369 --use=@autorest/java@4.0.17 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/appplatform/azure-resourcemanager-appplatform-generated --java.namespace=com.azure.resourcemanager.appplatform.generated   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/appplatform/resource-manager/readme.md
      cmderr	[generate.py] 2021-02-26 05:57:58 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-02-26 05:57:58 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-02-26 05:57:58 INFO [POM][Skip] pom already has module azure-resourcemanager-appplatform-generated
      cmderr	[generate.py] 2021-02-26 05:57:58 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-02-26 05:57:58 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-02-26 05:57:58 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-appplatform-generated [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-02-26 06:00:47 DEBUG Got artifact_id: azure-resourcemanager-appplatform-generated
      cmderr	[Inst] 2021-02-26 06:00:47 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-02-26 06:00:47 DEBUG Got artifact: azure-resourcemanager-appplatform-generated-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-02-26 06:00:47 DEBUG Got artifact: azure-resourcemanager-appplatform-generated-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-02-26 06:00:47 DEBUG Got artifact: azure-resourcemanager-appplatform-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-02-26 06:00:47 DEBUG Match jar package: azure-resourcemanager-appplatform-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-02-26 06:00:47 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12271/azure-sdk-for-java/azure-resourcemanager-appplatform-generated/azure-resourcemanager-appplatform-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-appplatform-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-appplatform-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-appplatform-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0e18f46. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6374 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/appplatform/resource-manager/readme.md
    • ️✔️appplatform [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager] WARN template-schema-validation-tools@1.0.0 No repository field.
      cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0e18f46. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️appplatform/mgmt/2020-07-01/appplatform [View full logs]  [Release SDK Changes]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `Inbound`
      info	[Changelog] - New const `Outbound`
      info	[Changelog] - New function `PossibleTrafficDirectionValues() []TrafficDirection`
      info	[Changelog] - New struct `RequiredTraffic`
      info	[Changelog] - New field `RequiredTraffics` in struct `NetworkProfile`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 6 additive change(s).
      info	[Changelog]
    • ️✔️preview/appplatform/mgmt/2020-11-01-preview/appplatform [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/appplatform/mgmt/2019-05-01-preview/appplatform [View full logs]  [Release SDK Changes]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `Deleting`
      info	[Changelog] - New const `DeploymentResourceProvisioningStateDeleting`
      info	[Changelog] - New const `Outbound`
      info	[Changelog] - New const `Inbound`
      info	[Changelog] - New function `PossibleTrafficDirectionValues() []TrafficDirection`
      info	[Changelog] - New struct `RequiredTraffic`
      info	[Changelog] - New field `RequiredTraffics` in struct `NetworkProfile`
      info	[Changelog] - New field `Sku` in struct `DeploymentResource`
      info	[Changelog] - New field `ToBeExportedForShoebox` in struct `MetricDimension`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 10 additive change(s).
      info	[Changelog]
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0e18f46. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/appplatform/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.AppPlatform [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-python warning [Detail]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0e18f46. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/appplatform/resource-manager/readme.md
    • ️✔️@azure/arm-appplatform [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/appPlatformManagementClient.js → ./dist/arm-appplatform.js...
      cmderr	[npmPack] created ./dist/arm-appplatform.js in 553ms
    ️️✔️[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

    Hi @bowen5, 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.ma/swaggerfeedback.

    @raych1
    Copy link
    Member

    raych1 commented Jan 5, 2021

    @bowen5 , could you paste the ADO work item for the S360 KPI for reference? Can you share the reason why it doesn't need to refresh SDK/CLI? Thanks.

    @bowen5
    Copy link
    Contributor Author

    bowen5 commented Jan 5, 2021

    @bowen5 , could you paste the ADO work item for the S360 KPI for reference? Can you share the reason why it doesn't need to refresh SDK/CLI? Thanks.

    Here yo go https://msazure.visualstudio.com/Swagger%20KPIs/_workitems/edit/8187806. What I did in this PR is 1. add default values in def, which I suppose no need SDK/CLI change as server side is already behaving like those default values? 2. add def in old preview version payload, which new latest SDK/CLI they are already using new version payload and already contains those changes.

    @raych1
    Copy link
    Member

    raych1 commented Jan 19, 2021

    @bowen5 , could you paste the ADO work item for the S360 KPI for reference? Can you share the reason why it doesn't need to refresh SDK/CLI? Thanks.

    Here yo go https://msazure.visualstudio.com/Swagger%20KPIs/_workitems/edit/8187806. What I did in this PR is 1. add default values in def, which I suppose no need SDK/CLI change as server side is already behaving like those default values? 2. add def in old preview version payload, which new latest SDK/CLI they are already using new version payload and already contains those changes.

    @bowen5 , is there any update for the breaking change review request?

    @ghost
    Copy link

    ghost commented Feb 21, 2021

    Hi, @bowen5. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Feb 21, 2021
    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.

    2 participants