Release api management 2023 09 01 preview #29024
Open
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
…023-05-01-preview to version 2023-09-01-preview
* WIP * Update sample * WIP * Add GatewayNameParameter * Clean up * Update sample * Add another sample * Add sample for delete gateway * Remove endpoints * Fix typo * Add list sample * Clean up Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Add disclaimer Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Make it pretty 💄 Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Refer to new file Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Add missing ApiManagementGatewayListResult Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Update sample reference Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Remove ApiManagementGatewayIdentity + List by operation Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Add more sample Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Latest version of common types Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Remove 200 for delete Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Formatting and re-order Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Align with spec Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Align sample with spec Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Error response from common types Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Rename SKU name * Have seperate SKU for patch to not make it mandatory * Remove empty required * Improve note * Rename schema * Remove unused type * sku.capacity should not be required --------- Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
) * Add loggers to workspaces * Add diagnostics to workspace * Add certificates to workspace * Add backends to workspaces * Change DiagnosticContract to DiagnosticContractProperties in patch * Revert back DiagnosticContractProperties to DiagnosticContract * Fix CI and add files to readme * Fix example * remove reconnect endpoint * Add suppressions * Try different suppression where * Try different suppression * Try other suppression * another test * finally working suppression * remove unwanted line
* md cb contract * modify pool contract * correct the limits --------- Co-authored-by: Samir Solanki <samirsolanki@outlook.com>
* add operation statuses resource * fix api-version
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| apimallpolicies.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimanagement.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimanagement.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimapis.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimapis.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimapisByTags.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimapisByTags.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimapiversionsets.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimapiversionsets.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimauthorizationproviders.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimauthorizationproviders.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimauthorizationservers.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimauthorizationservers.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimbackends.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimbackends.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimcaches.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimcaches.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimcertificates.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimcertificates.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimconnectivitycheck.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimconnectivitycheck.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimcontenttypes.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimcontenttypes.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimdeletedservices.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimdeletedservices.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimdeployment.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimdeployment.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimdiagnostics.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimdiagnostics.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimdocumentations.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimdocumentations.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimemailtemplates.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimemailtemplates.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimgateways.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimgateways.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimgroups.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimgroups.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimidentityprovider.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimidentityprovider.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimissues.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimissues.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimloggers.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimloggers.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimnamedvalues.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimnamedvalues.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimnetworkstatus.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimnetworkstatus.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimnotifications.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimnotifications.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimopenidconnectproviders.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimopenidconnectproviders.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimoutbounddependency.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimoutbounddependency.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimpolicies.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimpolicies.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimpolicydescriptions.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimpolicydescriptions.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimpolicyfragments.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimpolicyfragments.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimpolicyrestrictions.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimpolicyrestrictionsvalidation.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimportalconfigs.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimportalconfigs.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimportalrevisions.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimportalrevisions.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimportalsettings.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimportalsettings.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimprivatelink.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimprivatelink.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimproducts.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimproducts.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimproductsByTags.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimproductsByTags.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimquotas.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimquotas.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimregions.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimregions.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimreports.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimreports.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimschema.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimschema.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimsettings.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimsettings.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimskus.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimskus.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimsubscriptions.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimsubscriptions.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimtagresources.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimtagresources.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimtags.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimtags.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimtenant.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimtenant.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimusers.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| apimusers.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| apimworkspaces.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
| definitions.json | 2023-09-01-preview(18bed31) | 2022-08-01(main) |
| definitions.json | 2023-09-01-preview(18bed31) | 2023-05-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 5 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 5 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 10 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-preview-2023-09 | package-preview-2023-09(18bed31) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 5 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacebackends.json#L37 |
RPC-Get-V1-11 | |
| A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacecertificates.json#L37 |
RPC-Get-V1-11 | |
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacecertificates.json#L72 |
||
| A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacediagnostics.json#L37 |
RPC-Get-V1-11 | |
| A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacediagnostics.json#L391 |
RPC-Get-V1-11 |
The following errors/warnings exist before current PR submission:
Only 5 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L96 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Api_CreateOrUpdate' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema' Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L215 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L533 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L595 |
|
The 'apiId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L732 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The JSON file has a circular reference. readme: specification/apimanagement/resource-manager/readme.md json: Microsoft.ApiManagement/preview/2023-09-01-preview/definitions.json |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
solankisamir
added
2023-09-01-apim
AzureRestAPISpecReview
added
ARMReview
BreakingChangeReviewRequired
|
I followed https://eng.ms/docs/products/azure-developer-experience/design/api-specs-pr/api-tutorial/api-tutorial-3-publish#rebase-on-main and created another PR #29046 to avoid rebase issues |
* add operation results * fix spec * operationresults * fix file name
* new skutype * virtualNetworkType * remove default from patch * List skus API * add model for sku * caps enums
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.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.