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.

Sign up for GitHub

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

Jump to bottom

Rename Post Action and Add Secrets Tags #20775

Merged
merged 37 commits into from
Sep 27, 2022
Merged

Rename Post Action and Add Secrets Tags #20775

merged 37 commits into from
Sep 27, 2022

Conversation

xwang971
Copy link
Contributor

@xwang971 xwang971 commented Sep 19, 2022 •
edited
Loading

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.

ruslany and others added 30 commits April 13, 2022 11:04
@ruslany
Adds base for updating Microsoft.App from version stable/2022-03-01 t…
24d1f09 
…o version 2022-05-01
@ruslany
Updates readme
5e1015c
@ruslany
Updates API version in new specs and examples
bbd4441
@michimune
Add app diag to 2022-05-01 (#18678)
fabf9a5 
* Add container apps diagnostics

* Fix validation errors

* Move Microsoft.App diag APIs to 2022-05-01

* Fix validation errors

* Fix validation errors

* Fix validation errors 3

* Change operationIds

Co-authored-by: Michimune Kohno <mikono@microsoft.com>
@Juliehzl
Fix definition for customhostnameesult (#19014)
7077134 
* fix

* update

* more fix
@ruslany @vusause @tombuildsstuff
Cherry pick for the parameter name fixes for the 2022-03-01 and makin…
a33bd39 
…g the same fixes in 2022-05-01 (#19048)

* Correct Probe enums (#18839)

* fix probe enums

* Fix revision mode enum

* Fix patch example

* Fix the casing of enums in the latest api version

* Change the parameter names to unblock Terraform release (#19005)

* contianerapps: fixing swagger inconsistencies in 2022-01-01-preview

* containerapps: fixing inconsistencies in the 2022-03-01 swagger

* containerapps: updating the examples for 2022-01-01-preview

* containerapps: updating the examples to account for the updated parameter names

* containerapps: fixing linting

* fix probe enums

* Fix revision mode enum

* Fix the policheck error

* Revert "containerapps: fixing linting"

This reverts commit 3c4872f.

* Revert "containerapps: updating the examples for 2022-01-01-preview"

This reverts commit 9b81fbd.

* Revert "contianerapps: fixing swagger inconsistencies in 2022-01-01-preview"

This reverts commit 553fc55.

* Undo changes to 2022-01-01-preview

* Fix one issue

* fix remaining inconsistency

* fix authConfig and sourceControl names

Co-authored-by: tombuildsstuff <git@tom.ibuildstuff.eu>
Co-authored-by: Mike Vu <mikevu@microsoft.com>

* Change param names

* Fix examples

* Fix CI errors

Co-authored-by: Mike Vu <mikevu@microsoft.com>
Co-authored-by: tombuildsstuff <git@tom.ibuildstuff.eu>
@ruslany
Fix description in all API versions (#19313)
0fd5e26 
* Fix description for ManagedEnvironment.Internal property (#19307)

* Fix descriptions in all api versions
@ruslany
Add traffic info to revisions api (#19054)
056cc51 
* Add traffic info to a revision api

* Add deprecated prop

* Prettier fixes

* 1pdate based on new proposal

* Rename

* Change names

* minor fix
@ahmelsayed
Add httpReadBufferSize to dapr config in Microsoft.App-2022-05-01 (#1…
5421cc7 
…9360)

* Add httpReadBufferSize to dapr config

* remove nullable
@Juliehzl
Adds base for updating Microsoft.App from version stable/2022-05-01 t…
8e5d315 
…o version 2022-06-01-preview
@Juliehzl
Updates readme
45cd59b
@Juliehzl
Updates API version in new specs and examples
481bb59
@Juliehzl
Add new resources for 2022-06-01-preview (#19494)
ec34aa3 
* update

* update

* update

* fix

* update

* update

* update

* update

* fix

* update

* update
@LaylaLiu-gmail
Enable Dapr AI Connection string for Microsoft.App connected environm…
83d8432 
…ent (#19974)

* Enable Dapr AI Connection string for Microsoft.App connected environment

* Fix dapr ai connection string

* remove read

* remove read permission of dapr ai connection string and instrument key for managed environment

* fixes for comments
@Juliehzl
update (#20013)
8f6ff49
@ruslany
Fixdescriptions on microsoft.app 2022 06 01 preview (#20133)
6d7a4b0 
* Fix casing for detector properties

* Fix descriptions

* Fix descriptions and detectorProperties in 2022-06-01-preview
@ItalyPaleAle
Added secretsStoreComponent in 2022-06-01 spec (#20044)
baa9b05 
* Added `secretsStoreComponent` in 2022-06-01 spec

Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com>

* Fixed typos and added example of name/key

Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com>
@mjqin
Add custom domain configuration for managed environment (#20149)
bb43ed1 
Co-authored-by: Mengjun Qin <menqin@microsoft.com>
@ahmelsayed
Add additional Dapr options (2022-06-01-preview) (#19886)
94d84ee 
* Add additional Dapr options

* Update examples for 2022-06-01-preview

* force ci

* force ci

* force ci
@tdaroly
adding ip-restriction feat (#19841)
3450a5c 
* adding ip-restriction feat

* remove from stable, add to preview

* fix lintDiff error

* fix modelvalidation error

* fix formatting changes

* rename names, add note to all allow or all deny

* fix spell check error

* update name and examples

* rename `ipAddress` to `ipAddressRange`

* making small change to re-run build pipeline

* trigger GitHub actions

* resolve comments

Co-authored-by: Taher Darolywala <tdarolywala@microsoft.com>
@ruslany
Remove Traffic Labels from revisions because they haven't been impele…
903da55 
…mented (#20261)

* Revert "Add traffic info to revisions api (#19054)"

This reverts commit 056cc51.

* Remove traffic labels from revisions
@zhenqxuMSFT
Add property for tcp apps (#20193)
2b61c76 
* Add property for tcp apps

* Add scale

* Fix

* Fix
@p-bouchon
Add Init Containers to common definitions (#19855)
fba4c8b 
* add init containers to common definitions

* move changes to 06-01 preview

* remove repeated container definition

* fix allof syntax

* fix anonymous container definition

* fix lintdiff errors

* fix container allof syntax

* add more init examples

* split baseContainer definition

* remove description

Co-authored-by: p-bouchon <pbouchon@microsoft.com>
@Juliehzl
Update container app provisioningstate (#20411)
68a1c9e 
* update

* update
@njuCZ
add property: maxInactiveRevisions (#20334)
e4568a1 
* add property: maxInactiveRevisions

* update

* update
@jijohn14 @tadelesh
Add premium sku related properties for managed environment (#19770)
62f0c62 
* Add premium sku related properties for managed environment

* Move sku to base property

* Add workloadProfileType

* Examples for managed environment

* Add container app example

* Fix workloadProfiles

* Add custom word

* Fix WorkloadProfileType references

* prettier fixes

* Fix workload profile

* Fix typo

* remove readonly property for workload profile

* Add object type

* nit: Fix description location

* Fix XmsIdentifierValidation

* Remove spaces from enum values

* Remove unwanted change

* Add aka ms url

* Update examples for workload profile type

* Fix rebase issue

* Fix json

* Update description and move location

* Remove provisioning state for node pool

* sku capacity explanation

* Remove capacity attribute

* Remove capacity attribute from required

* Mark sku property as required

* Add x-ms-identifiers

* Rename mimum and maximum

* Rename skutype to skuName

* Make sku property as optional

* Make workload profile type as string

* fix go SDK automation config

Co-authored-by: Chenjie Shi <tadelesh.shi@live.cn>
@yalixiang
Fix source control status code in 2022-06-01-preview. (#20429)
483d3a4
@Juliehzl
Remove 20220501 because we will not support it in server side (#20427)
c6e7c42 
* remove

* update
@desokey
Added support for user defined routing (#20464)
b1aab39 
* Added support for user defined routing

* Added examples

* fixed JSON syntax

* syntax fix

* fixed vnetenvironment syntax

* fixed camel case

* case fix

* enum syntax

* fixed comma cases ManagedEnvironmentOutBoundType

* fixing casing
@xwang971
Some more APIs (#20448)
0cce38c 
* new APIs to 06-01

* test fix

* more fixes
@openapi-workflow-bot
Copy link

Hi @xwang971, 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

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.

@azure-sdk azure-sdk mentioned this pull request Sep 22, 2022
Closed
@xwang971
Copy link
Contributor Author

@leni-msft Hi, the authToken API is newly introduced to this version and we havent rolled out release based on this version yet so this would not break anything. Could we please remove the label and get this merged?

This was referenced Sep 22, 2022
Closed
Closed
Closed
@mentat9
Copy link
Member

mentat9 commented Sep 22, 2022

@xwang971 - The changes are good from ARM perspective, but the BreakingChangeReviewRequired label needs to be addressed before ARM signoff.

@xwang971
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@xwang971
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 26, 2022
@mentat9 mentat9 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 26, 2022
@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 Sep 26, 2022
@xwang971
Copy link
Contributor Author

@leni-msft Hi, the breacking change is approved, also got approval from ARM side, please take a look, thanks

@leni-msft leni-msft merged commit dcd9837 into main Sep 27, 2022
@leni-msft leni-msft deleted the renameAction branch September 27, 2022 09:46
@azure-sdk azure-sdk mentioned this pull request Sep 27, 2022
Closed
This was referenced Sep 27, 2022
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ruslany ruslany ruslany approved these changes

@leni-msft leni-msft leni-msft approved these changes

@jijohn14 jijohn14 jijohn14 approved these changes

Assignees

@leni-msft leni-msft

Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-FixRequiredOnFailure ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.