Skip to content

Adding Pool and Type to the Backend Contract#23968

Closed
m-h-s wants to merge 80 commits intoAzure:release-Microsoft.ApiManagement-2023-03-01-previewfrom
m-h-s:sadi/backendPool
Closed

Adding Pool and Type to the Backend Contract#23968
m-h-s wants to merge 80 commits intoAzure:release-Microsoft.ApiManagement-2023-03-01-previewfrom
m-h-s:sadi/backendPool

Conversation

@m-h-s
Copy link
Contributor

@m-h-s m-h-s commented May 12, 2023

ARM API Information (Control Plane)

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • 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. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

raych1 and others added 30 commits April 28, 2023 15:01
* Added 2023-01-03 Files swagger (Azure#22776)

* List Handles Access Rights (Azure#22779)
* init new version

* fixing validation errors

* rename cadl file

* fixing readme
Remove managed identity from the example payload as those will be created by system automatically.
… preview/2023-04-15-preview (Azure#23743)

* Adds base for updating Microsoft.HDInsight from version stable/2021-06-01 to version 2023-04-15-preview

* Updates readme

* Updates API version in new specs and examples

* modify request and examples

* fix ErrorResponse

* Revert "fix ErrorResponse"

This reverts commit 65b7c6c.

---------

Co-authored-by: Zhenhai Cao <fnuhaydn@microsoft.com>
* Update readme.python.md

* Update readme.python.md
* Update description to declare intent behind key-value management plane API.

* Update wording.
…re#23334)

* Adds base for updating Microsoft.CostManagement from version stable/2022-10-01 to version 2023-04-01-preview

* Updates readme

* Updates API version in new specs and examples

* Adding Budgets API translated from 2022-10-01 stable version of Micro… (Azure#22866)

* Adding Budgets API translated from 2022-10-01 stable version of Microsoft.Consumption/budgets

* Updating api-version in examples to 2023-04-01-preview

* Adding costmanagement.budgets.json to readme

* Addressing Swagger LintDiff errors

* Updating budget name pattern

* Adding suppression for R4011

* Adding budget name pattern regex for only alphanumeric, underscore, or hyphen characters

* fixing readme.go.md for budgets

* removing "object" type from notifications dictionary keys

* removing tags

* removing mismatching enum values

* updating notifications key type

* Revert "updating notifications key type"

This reverts commit eeb504b.

* Revert "removing mismatching enum values"

This reverts commit cba0132.

* updates to enum name

* Removing incorrect/outdated description info

* fixing BudgetsList example

* Updating example Ids to use Microsoft.CostManagement RP

* updating min & max length of budget name per conversations with PMs

* Adding suppressions for DeleteOperationResponses, TopLevelResourcesListBySubscription, and NoDuplicatePathsForScopeParameter

* fixing indentation in readme

* fixing formatting of suppressions in readme

* Adding paging back in, specifying as null for future use

* Adding support for RU Alerts in new Budgets API version (Azure#23140)

* Updating budgets swagger definition to include modifications from RU Alert category

* Adding new examples for all scenarios of RU Alerts, added new examples for all scopes for Cost Budgets

* Spelling & lintdiff fixes

* prettier-fix

* Added more descriptions, and some light markdown to larger descripitons

* Addressing comments

* prettier-fix

* Updating description for amount property

* addressing Shravan's offline comments

* spell check

* removing aws scopes from scope description

* Addressing comments from internal review, removed legacy tags for EA

* Alexprosak microsoft.cost management 2023 04 01 preview (Azure#23362)

* Updating readme default tag

* specifiying the word "update" in 200 response for budget createorupdate

* updating tags to package-preview-2023-04-01

* readme test

* Revert "readme test"

This reverts commit 566e2e6.

* Revert "updating tags to package-preview-2023-04-01"

This reverts commit f9cf3fe.

* Updating readme with previous apis not included and updated to current version

* Revert "Updating readme with previous apis not included and updated to current version"

This reverts commit bb87946.

* Alexprosak cost management microsoft.cost management 2023 04 01 preview (Azure#23770)

* changing azure-sdk-for-net to azure-sdk-for-net-track2 per ask from comment on main branch PR

* Adding in descriptions + examples for RU Alerts support at the customer scope

* fixing json formatting

* fixing example references

* Updating costmanagementproxyresource to reference ARM common proxy resource. Minor formatting change on scope parameter

* Updating common-types with updates to common-types from 2022-10-01 version

* prettier-fix

* Alprosms cost management microsoft.cost management 2023 04 01 preview (Azure#23795)

* updating costdetailreport swaggers from recent changes to 2022-10-01 version

* suppressing invalid LintDiff errors
…ft.DevCenter-2023-04-01' (Azure#23695)

* add or modify files

* Update readme.md

re-add azure-sdk-for-go
* initial fix

* address review comments

* fix release version s

* address gates failure

* address gate check failure
…preview/2023-03-15-preview (Azure#22993)

* Adds base for updating Microsoft.Insights from version preview/2022-08-01-preview to version 2023-03-15-preview

* Updates readme

* Updates API version in new specs and examples

* New api version - 2023-03-15-preview

* Fix Readme

* remove duplications from autorest readme

---------

Co-authored-by: meydand <t-meday@microsoft.com>
Co-authored-by: Meydan Dayan <meday@microsoft.com>
…view/2023-04-15-preview (Azure#23744)

* chore: update capability type and fix reference

* chore: update to fix lint issues
…nt (Azure#23593)

* Adding new status to EmailDeliveryReportReceived Event

Adding new status value "Suppressed" to EmailDeliveryReportReceived Event in AcsEvents

* Adding new property to Email event

* Adding new status

* Updates from feedback.

* Adding description for the enum

* Fix Prettier check

* Update description

* Updating example

* Updated swagger object def

* Updating property name

* renaming property
…e#23788)

* Remove duplication for PreBuiltResult and InputError

* Remove RequestStatistics in analyzetext.json

* Remove additionalProperties

* Add object type for PreBuiltResult
* Update OpenAI tspconfig to include Java emitter config

* remove unions for embedding options

* update docs
* New Azure Cognitive Search API version 2023-07-01-Preview
* Add Edm.Single as allowed search field type
* Remove unused query debug modes
* Add new api version to README
* Use additionalProperties: true
* Define schema for document lookup result
…isConfiguration (Azure#23726)

* Adds base for updating Microsoft.Cache from version stable/2022-06-01 to version 2023-04-01

* Updates readme

* Updates API version in new specs and examples

* Added new storage-subscription-id parameter for api version 2023-04-01

* test examples modified with new parameter

* Post review rephrasing of new parameter desc.

* Trigger Build
Updating the Description for the App Service Plans - Reboot Worker API. With VMSS stamps being utilized for App Services, the worker names need not necessarily have to start with RD. They can start with RD, dw, pd, xn, lw, pl, hr, aw, al etc. Due to multiple variations, making changes to the description.
…view/2023-05-01-preview (Azure#23745)

* Adds base for updating Microsoft.Cache from version stable/2022-06-01 to version 2023-05-01-preview

* Updates readme

* Updates API version in new specs and examples

* Take base changes from approved release branch 2023-05-01 preview

* Update api version label to 2023-05-01-preview

* Address PR suggestions from release branch

* Spec validation correction

* Add min max length for access policy and access policy assignment

* Remove breaking changes

* Remove body from delete 202 response

* Add add x-ms-parameter-location method

* Update redis readme

---------

Co-authored-by: Kanchan Joshi <kanchanjoshi@microsoft.com>
* adding incoming call

* adding incoming call

* adding incoming call event to Event grid

* fixing avocado failure

* fixing avocado failure

* fixing build failures

* fixing build failures

* Revert "fixing build failures"

This reverts commit 82b4ab3.

* fixing build failures

* Adding Incoming Call events to eventgrid swagger

* Addressing comments

* Adding Incoming Call events to eventgrid swagger

* Adding Incoming Call events to eventgrid swagger

* removing CallingCommunicationIdentifier

* removing unwanted string

* addressing comments

* making custom context its own defination

* making custom context its own defination

* adding the CommunicationIdentifier to property

* merging

* merging
* Update swagger for Dicom update events

* Added partition to Dicom events

* Added partition to subject

* Renamed partition name to default
This was referenced May 15, 2023
@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.

@raosuhas
Copy link
Member

Team , please fix and merge the branch to latest to ensure that only changed files come in the PR. This PR is not ready for review :

image

@openapi-workflow-bot
Copy link

Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 15, 2023
@solankisamir
Copy link
Member

Incorrectly created PR

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.

Comments