Add Bring your own Backend operations #18517
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @annikel Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
|
[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. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| 'PUT' operation 'StaticSites_LinkBackend' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L2984 |
|
| 'PUT' operation 'StaticSites_LinkBackendToBuild' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L3162 |
|
| 'DELETE' operation 'StaticSites_UnlinkBackend' should use method name 'Delete'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L3045 |
|
| 'DELETE' operation 'StaticSites_UnlinkBackendFromBuild' should use method name 'Delete'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L3230 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isCleaningAuthConfig Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L3065 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isCleaningAuthConfig Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L3257 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L118 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L161 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L206 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L267 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L313 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L375 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L432 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L488 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L558 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L608 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L660 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L718 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L781 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L844 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L901 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L955 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1009 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1066 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1125 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1206 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1267 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1331 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1387 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1498 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1548 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1600 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1668 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1723 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1787 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'StaticSites' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Web/stable/2022-03-01/StaticSites.json#L1835 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ModelValidation: 4 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Response statusCode 200 for operation StaticSites_ValidateBackend is provided in exampleResponseValue, however it is not present in the swagger spec. Url: Microsoft.Web/stable/2022-03-01/StaticSites.json#L2730:22 ExampleUrl: stable/2022-03-01/examples/ValidateLinkedBackendForStaticSite.json#L15:16 |
|
Following response status codes 202 for operation StaticSites_ValidateBackend were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: Microsoft.Web/stable/2022-03-01/StaticSites.json#L2734:18 ExampleUrl: stable/2022-03-01/examples/ValidateLinkedBackendForStaticSite.json#L15:16 |
|
Response statusCode 200 for operation StaticSites_ValidateBackendForBuild is provided in exampleResponseValue, however it is not present in the swagger spec. Url: Microsoft.Web/stable/2022-03-01/StaticSites.json#L2800:22 ExampleUrl: stable/2022-03-01/examples/ValidateLinkedBackendForStaticSiteBuild.json#L16:16 |
|
Following response status codes 202 for operation StaticSites_ValidateBackendForBuild were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: Microsoft.Web/stable/2022-03-01/StaticSites.json#L2804:18 ExampleUrl: stable/2022-03-01/examples/ValidateLinkedBackendForStaticSiteBuild.json#L16:16 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.9.3)
- current:stable/2022-03-01/StaticSites.json compared with base:stable/2021-03-01/StaticSites.json
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
Hi @annikel, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Apr 1, 2022
miwebst
approved these changes
Apr 5, 2022
mishapos
reviewed
Apr 5, 2022
specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/StaticSites.json
Outdated
Show resolved
Hide resolved
weidongxu-microsoft
approved these changes
Apr 6, 2022
@weidongxu-microsoft Like we discussed earlier if a particular PR where the target branch is the service branch needs ARM review we should tag it as such. The idea is that once PRs are merged to the service branch, we should not need another review to merge service branch to main branch. |
|
@weidongxu-microsoft I checked the boxes are couple of days ago. Will it be reviewed or is any additional information required? :) |
|
No you are not. This one " 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." |
|
Hi, @annikel your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
mentat9
reviewed
Apr 21, 2022
specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/StaticSites.json
Outdated
Show resolved
Hide resolved
mentat9
reviewed
Apr 21, 2022
specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/StaticSites.json
Outdated
Show resolved
Hide resolved
|
@mentat9 changed to 202 in four places |
This was referenced Apr 22, 2022
Closed
|
@mentat9 @weidongxu-microsoft so since it seems to be ARM approved now how will we proceed? |
weidongxu-microsoft
added a commit
that referenced
this pull request
Jun 24, 2022
* Adds base for updating Microsoft.Web from version stable/2021-03-01 to version 2022-03-01 * Updates readme * Updates API version in new specs and examples * Carry fwd Microsoft.CertificateRegistration and Microsoft.DomainRegis… (#18460) * Carry fwd Microsoft.CertificateRegistration and Microsoft.DomainRegistration RPs to Api-version 2022-03-01 * Add x-ms-enum for array of inline enums. Fix reference to older api version for common defs * Add examples for App Service Certificate orders * Add suppressions back * Add examples for Microsoft.DomainRegistration RP * Fixes from prettier * Remove unused example * Add Unhealthy CustomDomainStatus for StaticSites (#18557) * Adding VnetRouteAllEnabled, VnetImagePullEnabled, VnetContentShareEnabled site properties to CommonDefinitions (#18627) * Added vnet realted site properties to common definitions * removed tab Co-authored-by: Tanay Bhartia <tanaybhartia@microsoft.com> * Add Ftp/Remote debug properties to Ase network config (#18549) * Add Ftp/Remote debug properties to Ase network config * Switched changes to the right file * Add Networking config to hosting environment creates * Added some of the missing examples * Remove disallowed properties from example Ase GET response * Adjusted responses from other gets * Added a bunch more examples * Added other missing examples for Ase. * Added more missing examples for Ase. * fixed formatting * Edit some examples, add back privatelink apis and try to supress the errors for missing examples. * Fix suppress spelling and fix prettier * Added missing privatelink examples since suppressing did not work * Add Bring your own Backend operations (#18517) * add bring your own backend operations * add missing files * fix json formattin * validation fixes * fix * fix more validation * fix ids * fix model validation * fix descriptions * fix environmentName description * change to 202 * revert change to 202 * customhostnamesites optional param for 2022 API version (#18670) * fix DUPLICATE_PARAMETER * prettier * fix OBJECT_ADDITIONAL_PROPERTIES * fix random sub in examples * add optional hostname param to customHostnameSites RT and add examples * move changes from 2021 api version to 2022 * move examples to 2022 * Revert "add optional hostname param to customHostnameSites RT and add examples" This reverts commit 7fc318e. * remove examples from 2021 * fix lintDiff * prettier fix * model validation fix * suppress model validation in readme Co-authored-by: Elle Tojaroon <patojaro@microsoft.com> * [Microsoft.Web] Add CustomDnsSuffixConfiguration to ASE (#18553) * [Microsoft.Web] Add CustomDnsSuffixConfiguration to AppServiceEnvironments * Add examples * Fix style issues * Add customdnssuffix to custom-words * Add CustomDnsSuffixConfiguration to AppServiceEnvironment definition * Address remaining model validation errors * Adjusted networking configuration definitions * Addressed Arm review feedback Co-authored-by: Jarod Aerts <jarodaerts@microsoft.com> * Fork/web ant97 2022 03 01 (#19259) * Added DeploymentStatus API specs and examples * change status to enum, rm extra dot * suppress missing examples for now * rm id from List Deployment Slot examples * rm location, and rename deploymentId in GetSiteDeploymentStatus examples * change model as string to true, add 202 operations for DeploymentStatus ops to spec * rename operationId to deploymentStatusId, undo deploymentId rename * add long running op, as per linter Co-authored-by: Shubham Dhond <shdhond@microsoft.com> Co-authored-by: Weidong Xu <weidxu@microsoft.com> * PublicNetworkAccess Swagger Change (#19352) * add publicNetworkAccess property in site for swagger * add suppression to fix Model Validation CI * Add allowed values in the description * Add specs for Hosting Environment Maintenance Control (#18691) * Add documentation for Hosting Environment Maintenance Control * Update example file name * Make UpgradePreference non-nullable * Correct indentation to 2 spaces * Fix upgradePreference indentation * Address swagger feedback. Add enums with descriptions. * Move testNotification to request body. Update description text * Fix testNotification * Fix example * Replace TestNotification parameter with TestUpgradeNotification API * Rename to TestUpgradeAvailableNotification * Added logic apps operations (#18604) * Added Initial Operations and some definitions * Adding additional objects to support Logic Apps operations * Updated path and parameters to match testing * Prettier Fixes * oav validat-example fixes * Github validation fixes * Prettier * Updated examples and paths * Prettier * Revert "Prettier" This reverts commit da090ad. * Prettier * Fixed model validation errors * Filled in nextLinkName values * Fixing swagger lintdiff errors * added x-ms-long-running to async calls * Adds numberOfWorkers to app service plan (#19475) * Adds numberOfWorkers to app service plan * Add suppression for missing ASP examples * Updating to fix workflow errors (#19490) * Removed conflicting resource definition and added reference to CommonDefinitions.json (#19507) * Removed conflicting resource definition and added reference to CommonDefinitions.json * Updated resource to have workflow version * Updated nextLink object to be correctly tagged (#19560) * Updated nextLink object to be correctly tagged * Adding value placeholder * Updated SKU to remove conflict * Updated x-ms-enum * Added missing model * Adding more missing models * Add suppressions for missing examples (#19563) Co-authored-by: Joseph Lin <54335291+joslinmicrosoft@users.noreply.github.com> Co-authored-by: Tanay Bhartia <tanaybhartia@gmail.com> Co-authored-by: Tanay Bhartia <tanaybhartia@microsoft.com> Co-authored-by: JarodAertsMs <90280240+JarodAertsMs@users.noreply.github.com> Co-authored-by: annikel <92825476+annikel@users.noreply.github.com> Co-authored-by: Paviya (Elle) Tojaroon <pt335@cornell.edu> Co-authored-by: Elle Tojaroon <patojaro@microsoft.com> Co-authored-by: Chris Chen <chrc@microsoft.com> Co-authored-by: Jarod Aerts <jarodaerts@microsoft.com> Co-authored-by: edwin-msft <71858592+edwin-msft@users.noreply.github.com> Co-authored-by: Shubham Dhond <shdhond@microsoft.com> Co-authored-by: Weidong Xu <weidxu@microsoft.com> Co-authored-by: jiansong-msft <77516279+jiansong-msft@users.noreply.github.com> Co-authored-by: Derek Johnson <47129225+dejo-msft@users.noreply.github.com> Co-authored-by: Alex Karcher <alkarche@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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.
-[ ] 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.
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.