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

Microsoft.ExtendedLocation/customLocations Swagger #13101

Merged
merged 6 commits into from
Feb 23, 2021

Conversation

miosmian
Copy link
Contributor

@miosmian miosmian commented Feb 23, 2021

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

Recreating this PR from the private repository: https://github.com/Azure/azure-rest-api-specs-pr/pull/2984

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. Available Now: in eastus2euap,eastus,westeurope
  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 Breaking Change 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 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, @miosmian 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 Feb 23, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌LintDiff: 1 Errors, 4 Warnings failed [Detail]

    Rule Message
    R4011 - DeleteOperationResponses The delete operation is defined without a 200 or 204 error response implementation,please add it.'
    Location: Microsoft.ExtendedLocation/preview/2020-07-15-privatepreview/customlocations.json#L280
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'enabledResourceTypes' with immediate parent 'customLocation', must have a list by immediate parent operation.
    Location: Microsoft.ExtendedLocation/preview/2020-07-15-privatepreview/customlocations.json#L473
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction
    Location: Microsoft.ExtendedLocation/preview/2020-07-15-privatepreview/customlocations.json#L597
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Custom Location
    Location: Microsoft.ExtendedLocation/preview/2020-07-15-privatepreview/customlocations.json#L395
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Custom Location
    Location: Microsoft.ExtendedLocation/preview/2020-07-15-privatepreview/customlocations.json#L441
    ️️✔️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 pending [Detail]
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️⌛[Staging] SpellCheck pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 23, 2021

    Swagger Generation Artifacts

    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1c66936. 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-23 05:49:49 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-extendedlocation"
      cmderr	[generate.py] 2021-02-23 05:49:49 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-02-23 05:49:49 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/extendedlocation/azure-resourcemanager-extendedlocation --java.namespace=com.azure.resourcemanager.extendedlocation   --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/extendedlocation/resource-manager/readme.md
      cmderr	[generate.py] 2021-02-23 05:50:22 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-02-23 05:50:22 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-02-23 05:50:22 INFO [POM][Skip] pom already has module azure-resourcemanager-extendedlocation
      cmderr	[generate.py] 2021-02-23 05:50:22 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-02-23 05:50:22 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-02-23 05:50:22 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-extendedlocation [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-02-23 05:53:26 DEBUG Got artifact_id: azure-resourcemanager-extendedlocation
      cmderr	[Inst] 2021-02-23 05:53:26 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-02-23 05:53:26 DEBUG Got artifact: azure-resourcemanager-extendedlocation-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-02-23 05:53:26 DEBUG Got artifact: azure-resourcemanager-extendedlocation-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-02-23 05:53:26 DEBUG Got artifact: azure-resourcemanager-extendedlocation-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-02-23 05:53:26 DEBUG Match jar package: azure-resourcemanager-extendedlocation-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-02-23 05:53:26 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13101/azure-sdk-for-java/azure-resourcemanager-extendedlocation/azure-resourcemanager-extendedlocation-1.0.0-beta.1.jar\" -o azure-resourcemanager-extendedlocation-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-extendedlocation -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-extendedlocation-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1c66936. 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/extendedlocation/resource-manager/readme.md
    • ️✔️@azure/arm-extendedlocation [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/customLocations.js → ./dist/arm-extendedlocation.js...
      cmderr	[npmPack] created ./dist/arm-extendedlocation.js in 235ms
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1c66936. 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]../azure-sdk-for-python_tmp/generateOutput.json does not exist!!!
      warn	File azure-sdk-for-python_tmp/generateOutput.json not found to read
    • ️✔️azure-mgmt-extendedlocation [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1c66936. 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
    • ️✔️preview/extendedlocation/mgmt/2020-07-15-privatepreview/extendedlocation [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    ️❌[Staging] ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=196890&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
    "detail":"Run.ps1 failed with exit code 128 "
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    @miosmian miosmian deleted the miosmian/customlocations-swagger branch February 23, 2021 00:37
    @miosmian miosmian restored the miosmian/customlocations-swagger branch February 23, 2021 00:38
    @miosmian miosmian deleted the miosmian/customlocations-swagger branch February 23, 2021 00:38
    @miosmian miosmian restored the miosmian/customlocations-swagger branch February 23, 2021 01:13
    @miosmian miosmian reopened this Feb 23, 2021
    @miosmian
    Copy link
    Contributor Author

    miosmian commented Feb 23, 2021

    Re-opening this now directly against the azure-rest-api-specs repository. Previously had sign-offs on the private repository and can be merged. @allenjzhang CC'ing you here

    @allenjzhang
    Copy link
    Member

    @allenjzhang
    Copy link
    Member

    @msyyc, the python track 2 automation was skipped. Can you take a look at the readme.python.md to see if any change is needed?

    @allenjzhang allenjzhang merged commit 1c66936 into Azure:master Feb 23, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * save before rebase
    
    * rebase
    
    * recreating PR from private repo to be merged
    
    * updating python readme
    
    * remove readonly for consistency with internal repo - update python readme for sdk gen
    
    * after discussion - add back readonly on the systemdata
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants