2023-03-01-preview arm review feedback #24404
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, @solankisamir 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. [email protected] |
Swagger Validation Report
|
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-preview-2023-03 | package-preview-2023-03(6db278d) | package-preview-2023-03(release-Microsoft.ApiManagement-2023-03-01-preview) |
The following errors/warnings exist before current PR submission:
Only 30 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-03-01-preview/apimapis.json#L96 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L215 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L215 |
|
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-03-01-preview/apimapis.json#L215 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L340 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L509 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L571 |
|
The 'apiId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L708 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L1279 |
|
Query parameter format should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L1356 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L1583 |
|
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L1742 |
|
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L1742 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L1858 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2202 |
|
Query parameter format should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2282 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2506 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2555 |
|
Query parameter format should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2634 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2852 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2970 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L2970 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3050 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3161 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3522 |
|
Query parameter expandCommentsAttachments should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3600 |
|
The 'apiId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3666 |
|
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3691 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L3886 |
|
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimapis.json#L4057 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
ghost
added
the
Generated ApiView
|
This was referenced Jun 12, 2023
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @solankisamir, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi @solankisamir, 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. |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
@zedy-wj can you take a look at the PR and merge it as soon as possible? Thanks |
mikekistler
added
the
Approved-BreakingChange
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
zedy-wj
added
the
Approved-OkToMerge
live1206
approved these changes
Jun 15, 2023
live1206
pushed a commit
that referenced
this pull request
Jun 25, 2023
* Adds base for updating Microsoft.ApiManagement from version preview/2022-09-01-preview to version 2023-03-01-preview * Updates readme * Updates API version in new specs and examples * feat(apim): Provide capability to use custom hostname for Configuration API v2 (#23785) Signed-off-by: Tom Kerkhove <[email protected]> * feat(rp): Added flags to enable/disable portals (#23799) * feat(rp): Added flags to enable/disable portals * update default * feat(apim): Provide capability to disable legacy configuration API (#23786) * feat(apim): Provide capability to disable legacy configuration API Signed-off-by: Tom Kerkhove <[email protected]> * Update sample Signed-off-by: Tom Kerkhove <[email protected]> * Fix type definition Signed-off-by: Tom Kerkhove <[email protected]> * Switch to enum Signed-off-by: Tom Kerkhove <[email protected]> * Update samples Signed-off-by: Tom Kerkhove <[email protected]> --------- Signed-off-by: Tom Kerkhove <[email protected]> * feat(apim): Add new tracing API (#23800) * Add new tracing api * Remove TODOs descriptions * Improve descriptions * Fix dot * Add missing examples * prettier fixes * Fix model and semantic problems * Remove get prefix in post operations * Use list prefix * Fix PR comments * feat(apim): Add ability to create and update new OData api (#23849) * Add odata api definitions * add api usage example * fix file reference * address comments --------- Co-authored-by: rkolesnikov <[email protected]> * migration contract (#23983) * 2023 03 cred scan fix - Examples Only (#24357) * remove-sas-signature * update example * 2023-03-01-preview arm review feedback (#24404) * move to v5 subscription contract * move to v5 for rg and api-version * cred scan * default is true * uuid in examples * change from boolean to enums * fix default value --------- Signed-off-by: Tom Kerkhove <[email protected]> Co-authored-by: Tom Kerkhove <[email protected]> Co-authored-by: Harun Reşit <[email protected]> Co-authored-by: Rafał Mielowski <[email protected]> Co-authored-by: Roman Kolesnikov <[email protected]> Co-authored-by: rkolesnikov <[email protected]>
harryli0108
pushed a commit
to harryli0108/azure-rest-api-specs
that referenced
this pull request
Jul 28, 2023
* Adds base for updating Microsoft.ApiManagement from version preview/2022-09-01-preview to version 2023-03-01-preview * Updates readme * Updates API version in new specs and examples * feat(apim): Provide capability to use custom hostname for Configuration API v2 (Azure#23785) Signed-off-by: Tom Kerkhove <[email protected]> * feat(rp): Added flags to enable/disable portals (Azure#23799) * feat(rp): Added flags to enable/disable portals * update default * feat(apim): Provide capability to disable legacy configuration API (Azure#23786) * feat(apim): Provide capability to disable legacy configuration API Signed-off-by: Tom Kerkhove <[email protected]> * Update sample Signed-off-by: Tom Kerkhove <[email protected]> * Fix type definition Signed-off-by: Tom Kerkhove <[email protected]> * Switch to enum Signed-off-by: Tom Kerkhove <[email protected]> * Update samples Signed-off-by: Tom Kerkhove <[email protected]> --------- Signed-off-by: Tom Kerkhove <[email protected]> * feat(apim): Add new tracing API (Azure#23800) * Add new tracing api * Remove TODOs descriptions * Improve descriptions * Fix dot * Add missing examples * prettier fixes * Fix model and semantic problems * Remove get prefix in post operations * Use list prefix * Fix PR comments * feat(apim): Add ability to create and update new OData api (Azure#23849) * Add odata api definitions * add api usage example * fix file reference * address comments --------- Co-authored-by: rkolesnikov <[email protected]> * migration contract (Azure#23983) * 2023 03 cred scan fix - Examples Only (Azure#24357) * remove-sas-signature * update example * 2023-03-01-preview arm review feedback (Azure#24404) * move to v5 subscription contract * move to v5 for rg and api-version * cred scan * default is true * uuid in examples * change from boolean to enums * fix default value --------- Signed-off-by: Tom Kerkhove <[email protected]> Co-authored-by: Tom Kerkhove <[email protected]> Co-authored-by: Harun Reşit <[email protected]> Co-authored-by: Rafał Mielowski <[email protected]> Co-authored-by: Roman Kolesnikov <[email protected]> Co-authored-by: rkolesnikov <[email protected]>
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 API Information (Control Plane)
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 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.
-[ ] 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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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.