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

Azure Maps - fix readme settings #18016

Conversation

daniel-rocha
Copy link
Contributor

@daniel-rocha daniel-rocha commented Feb 26, 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 - Updating codegen settings in Readme files.
  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.
    March / 22 for the first SDKs.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    Already live.
  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 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 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, @daniel-rocha 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 Feb 26, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.

    ️️✔️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 Feb 26, 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-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from bdcc09a. 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.
      warn		specification/maps/data-plane/Search/readme.md skipped due to azure-sdk-for-python-track2 not found in swagger-to-sdk
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      cmderr	[automation_generate.sh] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.3.1 -> 8.5.2
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.5.2>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from bdcc09a. 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] 2022-02-28 05:21:20 INFO [Skip] readme path does not format as specification/*/resource-manager/readme.md
      cmderr	[generate.py] 2022-02-28 05:21:20 INFO [Skip] changed file specification/maps/data-plane/Render/preview/2.1/examples/SuccessfulAttributionRequest.json
      cmderr	[generate.py] 2022-02-28 05:21:20 INFO [Skip] changed file specification/maps/data-plane/Render/preview/2.1/examples/SuccessfulBoundingBoxCopyrightRequest.json
      cmderr	[generate.py] 2022-02-28 05:21:20 INFO [Skip] changed file specification/maps/data-plane/Render/preview/2.1/examples/SuccessfulStaticImageRequest.json
      cmderr	[generate.py] 2022-02-28 05:21:20 INFO [Skip] changed file specification/maps/data-plane/Render/preview/2.1/examples/SuccessfulTileRequest.json
      cmderr	[generate.py] 2022-02-28 05:21:20 INFO [GENERATE] Autorest from JSON ../azure-rest-api-specs/specification/maps/data-plane/Render/preview/2.1/render.json
      cmderr	[generate.py] 2022-02-28 05:21:20 INFO autorest --version=3.6.6 --use=@autorest/[email protected] --java --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-render --java.namespace=com.azure.maps.render --low-level-client --sdk-integration --generate-samples --input-file=../azure-rest-api-specs/specification/maps/data-plane/Render/preview/2.1/render.json  --artifact-id=azure-maps-render
      cmderr	[generate.py] 2022-02-28 05:21:51 INFO [VERSION][Not Found] cannot find version for "com.azure:azure-maps-render"
      cmderr	[generate.py] 2022-02-28 05:21:51 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2022-02-28 05:21:51 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2022-02-28 05:21:51 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2022-02-28 05:21:51 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2022-02-28 05:21:51 INFO [POM][Skip] pom already has module sdk/maps
      cmderr	[generate.py] 2022-02-28 05:21:51 INFO [POM][Success] Write to root pom
      cmderr	[generate.py] 2022-02-28 05:21:51 INFO mvn --no-transfer-progress clean verify package -f /home/vsts/work/1/s/azure-sdk-for-java/pom.xml -Dmaven.javadoc.skip -Dgpg.skip -Drevapi.skip -pl com.azure:azure-maps-render -am
      cmderr	[generate.py] 2022-02-28 05:23:51 ERROR [COMPILE] Maven build fail
      cmderr	[generate.py] 2022-02-28 05:23:51 INFO [Skip] changed file specification/maps/data-plane/Render/readme.java.md
      cmderr	[generate.py] 2022-02-28 05:23:51 INFO [Skip] changed file specification/maps/data-plane/Render/readme.md
    • ️✔️azure-maps-render [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2022-02-28 05:23:53 DEBUG Got artifact_id: azure-maps-render
      cmderr	[Inst] 2022-02-28 05:23:53 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2022-02-28 05:23:53 ERROR Unmatch any jar in artifacts
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from bdcc09a. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      warn		specification/maps/data-plane/Search/readme.md skipped due to azure-sdk-for-net not found in swagger-to-sdk
      command	autorest --version=2.0.4421 --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/Render/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
      command	autorest --version=2.0.4421 --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/Route/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.Render [View full logs]  [Release SDK Changes]
    • ️✔️Azure.Maps.Route [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @daniel-rocha, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @daniel-rocha daniel-rocha marked this pull request as ready for review February 26, 2022 06:08
    @daniel-rocha daniel-rocha requested a review from a team as a code owner February 26, 2022 06:08
    @daniel-rocha daniel-rocha requested review from JeffreyRichter and weidongxu-microsoft and removed request for a team February 26, 2022 06:08
    @daniel-rocha
    Copy link
    Contributor Author

    Hello @anuchandy @tjprescott @weidongxu-microsoft this is a change to add some more options to readme and fix some broken swagger examples. No breaking changes and passes all checks. Please approve and merge.

    @weidongxu-microsoft
    Copy link
    Member

    weidongxu-microsoft commented Feb 28, 2022

    LGTM. Added a few feedback but nothing required to be changed. Ping me again when you want it merged.

    @daniel-rocha
    Copy link
    Contributor Author

    LGTM. Added a few feedback but nothing required to be changed. Ping me again when you want it merged.

    @weidongxu-microsoft thanks for the review! please merge this PR now, thanks a lot.

    @weidongxu-microsoft weidongxu-microsoft merged commit bdcc09a into Azure:main Feb 28, 2022
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request Mar 7, 2022
    * Added content to support the new Render codegen settings
    
    * Changed license settings
    
    * Added settings for Route code generation
    
    * Added Search codegen settings
    
    * Modified codegen settings for Render
    
    * Modified x-ms-client-name to boundingBoxPrivate
    
    * Fixed model validation errors pointed out by OAV
    
    * Ran prettier to fix pipeline errors
    
    Co-authored-by: Daniel Rocha <[email protected]>
    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.

    4 participants