-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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.
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
Add profile level check endpoint name availability API #21646
Add profile level check endpoint name availability API #21646
Conversation
Swagger Validation Report
|
compared swaggers (via Oad v0.10.2)] | new version | base version |
---|---|---|
afdx.json | 2022-11-01-preview(fe7518e) | 2022-11-01-preview(main) |
Rule | Message |
---|---|
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L85:5 |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 1 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-preview-2022-11 | package-preview-2022-11(fe7518e) | package-preview-2022-11(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: CheckEndpointNameAvailability Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L92 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L136 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L185 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L357 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L406 |
ResourceNameRestriction |
The resource name parameter 'customDomainName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L406 |
RepeatedPathInfo |
The 'profileName' already appears in the path, please don't repeat it in the request body. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L473 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L521 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L521 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L614 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L678 |
ResourceNameRestriction |
The resource name parameter 'customDomainName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L678 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L679 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L740 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L789 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L789 |
RepeatedPathInfo |
The 'profileName' already appears in the path, please don't repeat it in the request body. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L856 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L899 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L997 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1061 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1061 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1062 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1132 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1132 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1188 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1188 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1250 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1299 |
ResourceNameRestriction |
The resource name parameter 'originGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1299 |
RepeatedPathInfo |
The 'profileName' already appears in the path, please don't repeat it in the request body. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1366 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1409 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
~[Staging] SwaggerAPIView 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.
️️✔️
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).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Hi, @ZianWang02 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 |
Swagger Generation Artifacts
|
Generated ApiView
|
Thank you for your contribution ZianWang02! We will review the pull request and get back to you soon. |
Hi, @ZianWang02 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
NewApiVersionRequired reason: |
@microsoft-github-policy-service agree [company="Microsoft"] |
@microsoft-github-policy-service agree company="Microsoft" |
According to the AddPath Rule, I believe that it can be considered an additive change in new api-version 2022-11-01-preview. Please correct me if I am wrong because it is my first swagger PR. @AzureRestAPISpecReview |
See: http://aka.ms/AzBreakingChangesPolicy/. Adding new path or operation requires a new api version. You can also reach out to Azure Breaking Changes Reviewers azbreakchangereview@microsoft.com for breaking changes information. |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
Hi @ZianWang02 , do you know whether there is any SDK already released based on 2022-11-01-preivew, if yes. you may need create new API version to add this new path. if no, consider this version is just merged 23 days ago. we can accept this additive change. normally, adding a new path in existing version is not allown according to breaking change policy |
Sure, let me check if there is any SDK released based on 2022-11-01-preview. |
Hi @akning-ms, I have confirmed with my team that there is no SDK released based on 2022-11-01-preview. Could you please accept this as an additive change? |
* Add profile level check endpoint name availability API * Update afdx.json
* Add profile level check endpoint name availability API * Update afdx.json
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:
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.
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.