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

ResourceHealth - Swagger - AVAILABILITYSTATUSES API - 2020-05-01 Stable & Preview API versions #15502

Merged
merged 68 commits into from
Sep 7, 2021

Conversation

srrudray
Copy link
Contributor

@srrudray srrudray commented Aug 3, 2021

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 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 (including refactoring) 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.

Stable - 2020-05-01 API version AvailabilityStatusesAPI
Preview - 2020-05-01 API version AvailabilityStatusesAPI
@openapi-workflow-bot
Copy link

Hi, @srrudray 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

    This comment has been minimized.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 3, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - resourcehealth/mgmt/2017-07-01/resourcehealth - v57.1.0
    ️✔️azure-sdk-for-go - resourcehealth/mgmt/2015-01-01/resourcehealth - v57.1.0
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from ab1f7f1. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️resourcehealth/mgmt/2017-07-01/resourcehealth [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️resourcehealth/mgmt/2015-01-01/resourcehealth [View full logs
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from ab1f7f1. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/resourcehealth/resource-manager/readme.md
    • ️✔️@azure/arm-resourcehealth [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/microsoftResourceHealth.js → ./dist/arm-resourcehealth.js...
      cmderr	[npmPack] created ./dist/arm-resourcehealth.js in 282ms
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from ab1f7f1. 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
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from ab1f7f1. 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-09-07 12:13:22 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-resourcehealth;1.0.0-beta.1;1.0.0-beta.2"
      cmderr	[generate.py] 2021-09-07 12:13:22 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-09-07 12:13:22 INFO autorest --version=3.4.5 --use=@autorest/[email protected] --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/resourcehealth/azure-resourcemanager-resourcehealth --java.namespace=com.azure.resourcemanager.resourcehealth   --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/resourcehealth/resource-manager/readme.md
      cmderr	[generate.py] 2021-09-07 12:13:51 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-resourcehealth
      cmderr	[generate.py] 2021-09-07 12:13:51 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-09-07 12:13:51 INFO [POM][Skip] pom already has module azure-resourcemanager-resourcehealth
      cmderr	[generate.py] 2021-09-07 12:13:51 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-09-07 12:13:51 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-09-07 12:13:51 INFO [POM][Skip] pom already has module sdk/resourcehealth
      cmderr	[generate.py] 2021-09-07 12:13:51 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-resourcehealth [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-09-07 12:15:46 DEBUG Got artifact_id: azure-resourcemanager-resourcehealth
      cmderr	[Inst] 2021-09-07 12:15:46 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-09-07 12:15:46 DEBUG Got artifact: azure-resourcemanager-resourcehealth-1.0.0-beta.2-javadoc.jar
      cmderr	[Inst] 2021-09-07 12:15:46 DEBUG Got artifact: azure-resourcemanager-resourcehealth-1.0.0-beta.2-sources.jar
      cmderr	[Inst] 2021-09-07 12:15:46 DEBUG Got artifact: azure-resourcemanager-resourcehealth-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-09-07 12:15:46 DEBUG Match jar package: azure-resourcemanager-resourcehealth-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-09-07 12:15:46 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/15502/azure-sdk-for-java/azure-resourcemanager-resourcehealth/azure-resourcemanager-resourcehealth-1.0.0-beta.2.jar\" -o azure-resourcemanager-resourcehealth-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-resourcehealth -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-resourcehealth-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️⚠️ azure-sdk-for-net warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from ab1f7f1. 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 [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/resourcehealth/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
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from ab1f7f1. 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 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
    • ️✔️resourcehealth [View full logs
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    @openapi-workflow-bot
    Copy link

    Hi, @srrudray your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 3, 2021
    @srrudray srrudray changed the title ResourceHealth - Swagger - AVAILABILITYSTATUSES - 2020-05-01 Stable & Purview API versions ResourceHealth - Swagger - AVAILABILITYSTATUSES - 2020-05-01 Stable & Preview API versions Aug 3, 2021
    @srrudray srrudray changed the title ResourceHealth - Swagger - AVAILABILITYSTATUSES - 2020-05-01 Stable & Preview API versions ResourceHealth - Swagger - AVAILABILITYSTATUSES API - 2020-05-01 Stable & Preview API versions Aug 3, 2021
    fixing the readme file
    adding stable 202-05-01 API version
    fixed the PR checks for ResourceHealth.json Stable 2020-05-01 API version
    fixed preview resourcehealth.json
    fixing the typo occurredTime
    fixing typo occurredTime
    @srrudray
    Copy link
    Contributor Author

    srrudray commented Aug 3, 2021

    Creating the PR to resolve the S360 - Swagger KPI Completeness
    KPI Link:
    https://vnext.s360.msftcloudes.com/blades/unifiedplatform?blade=AssignedTo:All~KPI:6dc4e485-2d1b-449c-a224-30b183391437~SLA:1~Forums:All~_loc:UnifiedPlatform&def=&peopleBasedNodes=ddove_team;prasank_team&tile=S360_ServiceId:ed05f3b7-8949-4698-9b38-49ab8abb5ee0~_loc:__key__UnifiedPlatform__6dc4e485-2d1b-449c-a224-30b183391437&global=4:ed05f3b7-8949-4698-9b38-49ab8abb5ee0

    Short description:
    Recently we are trying to new API version 2020-05-01 and 2020-05-Preview for only one of our API (i.e AvailabilityStatuses API)
    Currently, Other APIs are Not using it.

    I'm not sure, how to resolve some of the PR checks that are saying that why other API's are missing this API version

    @akning-ms
    Copy link
    Contributor

    Hi @srrudray, You can refer to https://aka.ms/ci-fix (state in first comments)to fix the validation error. if still has issue to fix. you can refer to #15502 (comment) to get further help.

    And seems you are adding 2 new version,(stable & preview with same date part 2020-05-01) can we know what different for them.

    and for our easy to review. best practice is (it can also be found in first comment) of this PR:
    Ensure you copy the existing version into the new directory structure for first commit (including refactoring) and then push new changes, including version updates, in separate commits.

    @srrudray
    Copy link
    Contributor Author

    srrudray commented Aug 4, 2021

    Hi @srrudray, You can refer to https://aka.ms/ci-fix (state in first comments)to fix the validation error. if still has issue to fix. you can refer to #15502 (comment) to get further help.

    And seems you are adding 2 new version,(stable & preview with same date part 2020-05-01) can we know what different for them.

    and for our easy to review. best practice is (it can also be found in first comment) of this PR:
    Ensure you copy the existing version into the new directory structure for first commit (including refactoring) and then push new changes, including version updates, in separate commits.

    1. The difference between 2 API version is
      Stable 2020-05-01 points to Production Traffic Manager
      where as, the Preview 2020-05-01 points to Staging TraffiManager

    This 2 versions are already existing in our ARM Manifest and are currently in use

    @chiragg4u
    Copy link
    Contributor

    Please complete the checklist for ARM API Review to continue. Specifically following is required

    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.

    fixing semantic validation
    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @jorgecotillo jorgecotillo added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 6, 2021
    @jorgecotillo
    Copy link
    Contributor

    Signed off from ARM side

    custom-words.txt Outdated Show resolved Hide resolved
    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 ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants