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

Update the label property of request body of find target resource api #17917

Merged
merged 3 commits into from
Feb 24, 2022

Conversation

peter-li-ms
Copy link
Contributor

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.
    Already deployed, this is a fix.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    Feb-25-2022
  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 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.

It should be a map with the key of "label".

Right now the request body is defined as:
{
  "key":"value"
}

But it should be changed to:
{
  "labels":{
    "key":"value"
   }
}
@openapi-workflow-bot
Copy link

Hi, @peter-li-ms 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 20, 2022

    Swagger Validation Report

    ️❌BreakingChange: 3 Errors, 0 Warnings failed [Detail]
    Rule Message
    1009 - RemovedRequiredParameter The required parameter 'labels' was removed in the new version.
    Old: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L423:11
    1010 - AddingRequiredParameter The required parameter 'parameters' was added in the new version.
    New: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L423:11
    1022 - RemovedAdditionalProperties The new version removes the 'additionalProperties' element.
    New: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L880:5
    Old: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L880:5
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    R4011 - DeleteOperationResponses The delete operation is defined without a 200 or 204 error response implementation,please add it.'
    Location: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L280
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L784
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L986
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'resourceSyncRules' with immediate parent 'customLocation', must have a list by immediate parent operation.
    Location: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L1128
    ⚠️ 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/2021-08-31-preview/customlocations.json#L932
    ⚠️ R4014 - AllResourcesMustHaveGetOperation The resource 'EnabledResourceType' does not have get operation, please add it.
    Location: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L751
    ⚠️ 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/2021-08-31-preview/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/2021-08-31-preview/customlocations.json#L542
    ️️✔️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 20, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-go-track2 - armextendedlocation - 0.3.0
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-extendedlocation - 1.0.0
    ️✔️azure-sdk-for-go - extendedlocation/mgmt/2021-08-15/extendedlocation - v61.5.0
    ️✔️azure-sdk-for-go - preview/extendedlocation/mgmt/2021-08-31-preview/extendedlocation - v61.5.0
    ️✔️azure-sdk-for-go - preview/extendedlocation/mgmt/2021-03-15-preview/extendedlocation - v61.5.0
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7c1fa28. 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
      cmderr	[automation_generate.sh]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.3.1 -> 8.5.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.5.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-extendedlocation [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation CustomLocationsOperations.find_target_resource_group
      info	[Changelog]   - Added operation group ResourceSyncRulesOperations
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7c1fa28. 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-24 03:58:15 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-extendedlocation;1.0.0-beta.1;1.0.0-beta.2"
      cmderr	[generate.py] 2022-02-24 03:58:15 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2022-02-24 03:58:15 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/extendedlocation/azure-resourcemanager-extendedlocation --java.namespace=com.azure.resourcemanager.extendedlocation   --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --generate-samples --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/extendedlocation/resource-manager/readme.md
      cmderr	[generate.py] 2022-02-24 03:58:39 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-extendedlocation
      cmderr	[generate.py] 2022-02-24 03:58:39 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2022-02-24 03:58:39 INFO [POM][Skip] pom already has module azure-resourcemanager-extendedlocation
      cmderr	[generate.py] 2022-02-24 03:58:39 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2022-02-24 03:58:39 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2022-02-24 03:58:39 INFO [POM][Skip] pom already has module sdk/extendedlocation
      cmderr	[generate.py] 2022-02-24 03:58:39 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-extendedlocation [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2022-02-24 04:00:03 DEBUG Got artifact_id: azure-resourcemanager-extendedlocation
      cmderr	[Inst] 2022-02-24 04:00:03 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2022-02-24 04:00:03 DEBUG Got artifact: azure-resourcemanager-extendedlocation-1.0.0-beta.2-sources.jar
      cmderr	[Inst] 2022-02-24 04:00:03 DEBUG Got artifact: azure-resourcemanager-extendedlocation-1.0.0-beta.2.jar
      cmderr	[Inst] 2022-02-24 04:00:03 DEBUG Match jar package: azure-resourcemanager-extendedlocation-1.0.0-beta.2.jar
      cmderr	[Inst] 2022-02-24 04:00:03 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/17917/azure-sdk-for-java/azure-resourcemanager-extendedlocation/azure-resourcemanager-extendedlocation-1.0.0-beta.2.jar\" -o azure-resourcemanager-extendedlocation-1.0.0-beta.2.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.2.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7c1fa28. SDK Automation 14.0.0
      command	sh ./eng/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
    • ️✔️extendedlocation/mgmt/2021-08-15/extendedlocation [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️preview/extendedlocation/mgmt/2021-08-31-preview/extendedlocation [View full logs
      info	[Changelog] This is a new package
      info	[Changelog]
    • ️✔️preview/extendedlocation/mgmt/2021-03-15-preview/extendedlocation [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7c1fa28. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️armextendedlocation [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `ErrorDetail.MarshalJSON` has been removed
      info	[Changelog] - Struct `ErrorAdditionalInfo` has been removed
      info	[Changelog] - Struct `ErrorDetail` has been removed
      info	[Changelog] - Struct `ErrorResponse` has been removed
      info	[Changelog]
      info	[Changelog] Total 7 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7c1fa28. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      cmderr	[automation_init.sh]  [email protected]: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh]  [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file.
      cmderr	[automation_init.sh] npm WARN @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️track2_@azure/arm-extendedlocation [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @peter-li-ms, 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.

    @openapi-workflow-bot
    Copy link

    Hi @peter-li-ms, 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.ms/swaggerfeedback.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 23, 2022
    @chunyu3 chunyu3 self-requested a review February 24, 2022 03:50
    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 Approved-SdkBreakingChange-Go-V2 CI-BreakingChange-Go-V2 FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants