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

Add Microsoft.ExtendedLocation [CustomLocation] 2021-08-15 stable API Version #15967

Merged

Conversation

aditimalladi
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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    10th Sept 2021
  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, @aditimalladi 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-pipeline-app
    Copy link

    Swagger pipeline can not start as the pull request has merge conflicts.

    @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

    Swagger pipeline can not start as the pull request has merge conflicts.

    @openapi-workflow-bot
    Copy link

    Hi, @aditimalladi 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 Sep 8, 2021
    @openapi-pipeline-app
    Copy link

    Swagger pipeline can not start as the pull request has merge conflicts.

    1 similar comment
    @openapi-pipeline-app
    Copy link

    Swagger pipeline can not start as the pull request has merge conflicts.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 9, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️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/stable/2021-08-15/customlocations.json#L280
    R4037 - MissingTypeObject The schema 'customLocationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L557
    R4037 - MissingTypeObject The schema 'customLocationOperation' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L575
    R4037 - MissingTypeObject The schema 'customLocationOperationValueDisplay' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L600
    R4037 - MissingTypeObject The schema 'customLocationOperationsList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L625
    ⚠️ 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/stable/2021-08-15/customlocations.json#L583
    ⚠️ R4014 - AllResourcesMustHaveGetOperation The resource 'EnabledResourceType' does not have get operation, please add it.
    Location: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L428
    ⚠️ 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/stable/2021-08-15/customlocations.json#L395
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️❌Cross-Version Breaking Changes: 8 Errors, 0 Warnings failed [Detail]
    The following breaking changes are detected by comparison with latest preview version:
    Rule Message
    1008 - ModifiedOperationId The operation id has been changed from 'customLocations_ListOperations' to 'CustomLocations_ListOperations'. This will impact generated code.
    New: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L38:7
    Old: Microsoft.ExtendedLocation/preview/2021-03-15-preview/customlocations.json#L38:7
    1008 - ModifiedOperationId The operation id has been changed from 'customLocations_ListBySubscription' to 'CustomLocations_ListBySubscription'. This will impact generated code.
    New: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L75:7
    Old: Microsoft.ExtendedLocation/preview/2021-03-15-preview/customlocations.json#L75:7
    1008 - ModifiedOperationId The operation id has been changed from 'customLocations_ListByResourceGroup' to 'CustomLocations_ListByResourceGroup'. This will impact generated code.
    New: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L115:7
    Old: Microsoft.ExtendedLocation/preview/2021-03-15-preview/customlocations.json#L115:7
    1008 - ModifiedOperationId The operation id has been changed from 'customLocations_Get' to 'CustomLocations_Get'. This will impact generated code.
    New: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L158:7
    Old: Microsoft.ExtendedLocation/preview/2021-03-15-preview/customlocations.json#L158:7
    1008 - ModifiedOperationId The operation id has been changed from 'customLocations_CreateOrUpdate' to 'CustomLocations_CreateOrUpdate'. This will impact generated code.
    New: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L199:7
    Old: Microsoft.ExtendedLocation/preview/2021-03-15-preview/customlocations.json#L199:7
    1008 - ModifiedOperationId The operation id has been changed from 'customLocations_Delete' to 'CustomLocations_Delete'. This will impact generated code.
    New: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L259:7
    Old: Microsoft.ExtendedLocation/preview/2021-03-15-preview/customlocations.json#L259:7
    1008 - ModifiedOperationId The operation id has been changed from 'customLocations_Update' to 'CustomLocations_Update'. This will impact generated code.
    New: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L304:7
    Old: Microsoft.ExtendedLocation/preview/2021-03-15-preview/customlocations.json#L304:7
    1008 - ModifiedOperationId The operation id has been changed from 'customLocations_ListEnabledResourceTypes' to 'CustomLocations_ListEnabledResourceTypes'. This will impact generated code.
    New: Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json#L357:7
    Old: Microsoft.ExtendedLocation/preview/2021-03-15-preview/customlocations.json#L357:7
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] 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 Sep 9, 2021

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-python-track2 - track2_azure-mgmt-extendedlocation - 1.0.0b2
    +	Operation CustomLocationsOperations.update has a new signature
    ️✔️azure-sdk-for-go - extendedlocation/mgmt/2021-08-15/extendedlocation - v57.1.0
    ️✔️azure-sdk-for-go - preview/extendedlocation/mgmt/2021-03-15-preview/extendedlocation - v57.1.0
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 382987f. 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
    • ️✔️track2_azure-mgmt-extendedlocation [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model CustomLocation has a new parameter identity
      info	[Changelog]   - Model PatchableCustomLocations has a new parameter identity
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Operation CustomLocationsOperations.update has a new signature
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 382987f. 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-10 07:16:58 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-extendedlocation"
      cmderr	[generate.py] 2021-09-10 07:16:58 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-09-10 07:16:58 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/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-09-10 07:17:27 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-09-10 07:17:27 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-09-10 07:17:27 INFO [POM][Skip] pom already has module azure-resourcemanager-extendedlocation
      cmderr	[generate.py] 2021-09-10 07:17:27 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-09-10 07:17:27 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-09-10 07:17:27 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-extendedlocation [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-09-10 07:18:45 DEBUG Got artifact_id: azure-resourcemanager-extendedlocation
      cmderr	[Inst] 2021-09-10 07:18:45 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-09-10 07:18:45 DEBUG Got artifact: azure-resourcemanager-extendedlocation-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-09-10 07:18:45 DEBUG Match jar package: azure-resourcemanager-extendedlocation-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-09-10 07:18:45 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/15967/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-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 382987f. 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
    • ️✔️extendedlocation/mgmt/2021-08-15/extendedlocation [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️preview/extendedlocation/mgmt/2021-03-15-preview/extendedlocation [View full logs
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 382987f. 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/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 239ms
    Posted by Swagger Pipeline | How to fix these errors?

    @aditimalladi aditimalladi changed the title Add 2021-08-15 stable API Version Add Microsoft.ExtendedLocation [CustomLocation] 2021-08-15 stable API Version Sep 9, 2021
    @openapi-workflow-bot
    Copy link

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

    }
    }
    },
    "Identity": {
    Copy link
    Member

    Choose a reason for hiding this comment

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

    Identity

    If you're planning to add user assigned identities in the future, you should consider referencing the equivalent definition from common types v2. It would allow you to add support for UAIs without breaking changes.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    We would want to reference common types but so far the common types (v2) only supports SystemAssigned identity, while in this PR we are adding SystemAssigned and None types.

    Common Types (v2) : https://github.com/Azure/azure-rest-api-specs/blob/main/specification/common-types/resource-management/v2/types.json#L245

    @majastrz majastrz 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 9, 2021
    Copy link
    Member

    @majastrz majastrz left a comment

    Choose a reason for hiding this comment

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

    Signed off from ARM side with a suggestion.

    @jianyexi jianyexi merged commit 382987f into Azure:main Sep 10, 2021
    iscai-msft added a commit to iscai-msft/azure-rest-api-specs that referenced this pull request Sep 10, 2021
    …into add_endpoint
    
    * 'main' of https://github.com/Azure/azure-rest-api-specs: (5079 commits)
      Add Microsoft.ExtendedLocation [CustomLocation] 2021-08-15 stable API Version (Azure#15967)
      Updated SKU property to be read only (Azure#15965)
      Add Microsoft.Communication.UserDisconnected Event (Azure#15870)
      Add collection APIs (Azure#15221)
      [Cognitive Services - Personalizer] v1.1-preview.2 (Azure#15699)
      Adding default error response & updating basePath (Azure#15784)
      Update readme and readme.python (Azure#15973)
      add synapse batch tag package-composite-v1 (Azure#15974)
      Microsoft.BareMetalInfrastructure: add stable API version 2021-08-09 (Azure#15680)
      change readme.go.md template to track 2 (Azure#15972)
      [CosmosDB] Adding apiVersion 2021-07-01-preview (Azure#14817)
      Merge Dev-containerservice-microsoft.containerservice-2021-08-01 branch to main (Azure#15954)
      DiskRP swagger for 2021-04-01 (Azure#15665)
      Use IncidentSeverity in IncidentInfo (Azure#15762)
      Add stable API version "2021-09-01" (Azure#15897)
      add-purview-typescript-file (Azure#15948)
      Swagger Completeness for Microsoft.Authorization (Azure#15253)
      [Hub Generated] Review request for Microsoft.Aadiam to add version preview/2020-03-01-preview and stable/2020-03-01 (Azure#15861)
      Add swagger for missing CheckPolicyRestrictions API version (Azure#15888)
      Add Red Hat OpenShift 2021-09-01-preview (Azure#15616)
      ...
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants