Skip to content

Conversation

@john35452
Copy link
Contributor

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

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 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.

@openapi-workflow-bot
Copy link

Hi, @john35452 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 Oct 12, 2021

    Swagger Validation Report

    ️❌BreakingChange: 3 Errors, 0 Warnings failed [Detail]
    Rule Message
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Weather/preview/1.0/weather.json#L576:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Weather/preview/1.0/weather.json#L631:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Weather/preview/1.0/weather.json#L692:5
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️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.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️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 Oct 12, 2021

    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-python-track2 failed [Detail]
    • Failed [Logs] Generate from 79d0eb937b51910c881b02d34584f79a9a0bdb9c. 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
      cmdout	[automation_generate.sh] [Autorest]/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
      warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 79d0eb937b51910c881b02d34584f79a9a0bdb9c. 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-11-19 19:08:14 INFO [Skip] readme path does not format as specification/*/resource-manager/readme.md
      cmderr	[generate.py] 2021-11-19 19:08:14 INFO [Skip] changed file specification/maps/data-plane/Weather/preview/1.0/examples/GetCurrentAirQuality.json
      cmderr	[generate.py] 2021-11-19 19:08:14 INFO [Skip] changed file specification/maps/data-plane/Weather/preview/1.0/examples/GetCurrentConditions.json
      cmderr	[generate.py] 2021-11-19 19:08:14 INFO [Skip] changed file specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyAirQuality.json
      cmderr	[generate.py] 2021-11-19 19:08:14 INFO [Skip] changed file specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyForecast.json
      cmderr	[generate.py] 2021-11-19 19:08:14 INFO [Skip] changed file specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyIndices.json
      cmderr	[generate.py] 2021-11-19 19:08:14 INFO [Skip] changed file specification/maps/data-plane/Weather/preview/1.0/examples/GetHourlyAirQuality.json
      cmderr	[generate.py] 2021-11-19 19:08:14 INFO [Skip] changed file specification/maps/data-plane/Weather/preview/1.0/examples/GetHourlyForecast.json
      cmderr	[generate.py] 2021-11-19 19:08:14 INFO [Skip] changed file specification/maps/data-plane/Weather/preview/1.0/examples/GetMinuteForecast.json
      cmderr	[generate.py] 2021-11-19 19:08:14 INFO [Skip] changed file specification/maps/data-plane/Weather/preview/1.0/examples/GetQuarterDayForecast.json
      cmderr	[generate.py] 2021-11-19 19:08:14 INFO [Skip] changed file specification/maps/data-plane/Weather/preview/1.0/examples/GetSevereWeatherAlerts.json
      cmderr	[generate.py] 2021-11-19 19:08:14 INFO autorest --version=3.6.0 --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/maps/azure-maps-weather --java.namespace=com.azure.maps.weather --java --low-level-client --sdk-integration --generate-samples --input-file=../azure-rest-api-specs/specification/maps/data-plane/Weather/preview/1.0/weather.json --java.credential-types=tokencredential --java.credential-scopes=https://maps.azure.com/.default
      cmderr	[generate.py] 2021-11-19 19:08:49 INFO mvn --no-transfer-progress clean install -f /home/vsts/work/1/s/azure-sdk-for-java/pom.xml -pl com.azure:sdk-build-tools
      cmderr	[generate.py] 2021-11-19 19:09:11 INFO mvn --no-transfer-progress clean verify package -f /home/vsts/work/1/s/azure-sdk-for-java/sdk/maps/azure-maps-weather/pom.xml
      cmderr	[generate.py] 2021-11-19 19:09:56 ERROR [COMPILE] Maven build fail
    • ️✔️azure-maps-weather [View full logs]  [Preview SDK Changes]
      cmderr	[Inst] 2021-11-19 19:10:02 DEBUG Got artifact_id: azure-maps-weather
      cmderr	[Inst] 2021-11-19 19:10:02 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-11-19 19:10:02 ERROR Unmatch any jar in artifacts
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 79d0eb937b51910c881b02d34584f79a9a0bdb9c. 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/maps/data-plane/Weather/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
    • ️✔️Azure.Maps.Weather [View full logs]  [Preview 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.

    Copy link
    Member

    Choose a reason for hiding this comment

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

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Copy link
    Member

    Choose a reason for hiding this comment

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

    given values are in 1 ... 7 range, you can add minimum and maximum which will be used for client side parameter validation:

    {
          "name": "duration",
          "description": "...",
          "default": 1,
          "in": "query",
          "type": "integer",
          "minimum": 1,
          "maximum": 7
    }
    

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Thanks for the suggestion!
    Updated!

    Copy link
    Member

    Choose a reason for hiding this comment

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

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Copy link
    Member

    Choose a reason for hiding this comment

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

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Copy link
    Member

    Choose a reason for hiding this comment

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

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Copy link
    Member

    Choose a reason for hiding this comment

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

    such 1, 12, 24, 48, 72, 96. will likely get requested to be enumed.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Thanks for the suggestion! I have added an enum for this.

    Copy link

    @eriklindeman eriklindeman Nov 11, 2021

    Choose a reason for hiding this comment

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

    The API actually supports up to 7 days, not up to 4 days. I know the spec says up to 4 days, but I think that might have been for AccuWeather's v1 Air Quality API (v2 supports up to 7 days). Sorry, the spec should have been updated accordingly - I missed that early. Therefore, please...

    Change:
    The service provides the detailed information about the concentration of pollutant and overall status for upcoming few days air quality. The service can provide forecast air quality for future one to four days.

    To:
    Get detailed information about the concentration of pollutants and overall status of forecasted daily air quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Thanks for the remind!
    Updated

    Choose a reason for hiding this comment

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

    For pricing tiers, instead of ‘S1 and G2 pricing tiers.’, state as ‘Gen 1 (S0 and S1) and Gen 2 pricing tiers.’ to be consistent with how all the Azure Maps are going to be updated with soon.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Choose a reason for hiding this comment

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

    Change:
    The service provides the detailed information about the concentration of pollutant and overall status for current air quality.

    To:
    Get detailed information about the concentration of pollutants and overall status for current air quality. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Choose a reason for hiding this comment

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

    For pricing tiers, instead of ‘S1 and G2 pricing tiers.’, state as ‘Gen 1 (S0 and S1) and Gen 2 pricing tiers.’ to be consistent with how all the Azure Maps are going to be updated with soon.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Choose a reason for hiding this comment

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

    Change:
    The service provides the detailed information about the concentration of pollutant and overall status for current air quality.

    To:
    Get detailed information about the concentration of pollutants and overall status for forecasted upcoming hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans of 1, 12, 24, 48, 72, and 96 hours. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Choose a reason for hiding this comment

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

    For pricing tiers, instead of ‘S1 and G2 pricing tiers.’, state as ‘Gen 1 (S0 and S1) and Gen 2 pricing tiers.’ to be consistent with how all the Azure Maps are going to be updated with soon.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Choose a reason for hiding this comment

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

    Change:
    Get Air Quality Hourly forecast

    To:
    Get Air Quality Hourly Forecast

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Choose a reason for hiding this comment

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

    XML not supported, only JSON, so we should remove mention of XML support.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Choose a reason for hiding this comment

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

    XML not supported, only JSON, so we should remove mention of XML support.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Choose a reason for hiding this comment

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

    XML not supported, only JSON, so we should remove mention of XML support.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    @openapi-workflow-bot
    Copy link

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

    @john35452 john35452 force-pushed the dev-maps-Weather-1.0 branch from 003757d to 3f2a39e Compare November 16, 2021 07:47
    },
    "/weather/airQuality/forecast/hourly/{format}": {
    "get": {
    "description": "**Get Air Quality Hourly Forecast**\n\n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.n\nGet detailed information about the concentration of pollutants and overall status for forecasted upcoming hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans of 1, 12, 24, 48, 72, and 96 hours. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.",

    Choose a reason for hiding this comment

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

    There is a spacing issue in the text.

    Change:
    .n\nGet

    To:
    . \n\nGet

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Updated

    Copy link

    @eriklindeman eriklindeman left a comment

    Choose a reason for hiding this comment

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

    Minor typo fix request.

    Copy link

    @eriklindeman eriklindeman left a comment

    Choose a reason for hiding this comment

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

    The documentation looks good, all my suggested changes have been added.

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

    Labels

    None yet

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    6 participants