Fix response code in spec to correct reflect the approve or reject private endpoint connection API's behavior #17015
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, @yingru97 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] |
|
[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. |
ghost
added
the
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version adds a response code '202'. New: Microsoft.ApiManagement/stable/2021-08-01/apimprivatelink.json#L171:11 |
|
The new version removes the response code '201' Old: Microsoft.ApiManagement/stable/2021-08-01/apimprivatelink.json#L171:11 |
️⚠️LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response of operation:'SignInSettings_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/stable/2021-08-01/apimportalsettings.json#L123 |
|
The response of operation:'SignUpSettings_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/stable/2021-08-01/apimportalsettings.json#L315 |
|
The response of operation:'DelegationSettings_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/stable/2021-08-01/apimportalsettings.json#L507 |
|
The response of operation:'SignInSettings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/stable/2021-08-01/apimportalsettings.json#L218 |
|
The response of operation:'SignUpSettings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/stable/2021-08-01/apimportalsettings.json#L410 |
|
The response of operation:'DelegationSettings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.ApiManagement/stable/2021-08-01/apimportalsettings.json#L602 |
|
The response schema of operations API '/providers/Microsoft.ApiManagement/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ApiManagement/stable/2021-08-01/apimdeployment.json#L37 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L38 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L55 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L65 |
|
The schema 'RegionContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L85 |
|
The schema 'RegionListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L103 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L38 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L65 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L55 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L38 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L65 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L55 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L38 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L65 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L55 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L38 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L65 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L55 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L38 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L65 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L55 |
|
The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L38 |
|
The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L65 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L55 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️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.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
Hi @yingru97, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
NewApiVersionRequired reason: |
|
Hi @yingru97, 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. |
yingru97
changed the title
yingru97
changed the title
This was referenced Dec 9, 2021
|
Hi @yingru97 changing the response code is a breaking change, therefore could you please follow this comment to open a breaking change review item to get approval for this breaking change? |
|
Hi, @yingru97. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
JeffreyRichter
added
the
Approved-BreakingChange
solankisamir
approved these changes
Jan 3, 2022
I've got approval from the Azure breaking change team, can you merge the PR? |
|
@ArcturusZhang can you please merge this, if you feel all the requirements are met? This is blocking our client development pipeline and some customers are waiting on it. |
|
you might need to update this example "$ref": "./examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json" to respond 202 |
openapi-pipeline-app
bot
removed
CI-FixRequiredOnFailure
CI-BreakingChange-Python
labels
|
@ArcturusZhang can you please merge this, if you feel all the requirements are met? This is blocking our client development pipeline and some customers are waiting on it. |
ArcturusZhang
approved these changes
Jan 11, 2022
This was referenced Jan 11, 2022
mstrisoline
pushed a commit
to mstrisoline/azure-rest-api-specs
that referenced
this pull request
Feb 1, 2022
…ivate endpoint connection API's behavior (Azure#17015) * added fix * Update ApiManagementApproveOrRejectPrivateEndpointConnection.json Updated Example
LeiWang3
pushed a commit
to LeiWang3/azure-rest-api-specs
that referenced
this pull request
Mar 31, 2022
…ivate endpoint connection API's behavior (Azure#17015) * added fix * Update ApiManagementApproveOrRejectPrivateEndpointConnection.json Updated Example
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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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.