-
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
[Quantum] Change Azure Quantum Data Plane 2022-09-12-preview scope for Azure authentication #24212
Conversation
Hi, @chuanqixu 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 swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
quantum.json | 2022-09-12-preview(a4620b9) | 2022-09-12-preview(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.2) | new version | base version |
---|---|---|
package-2022-09-12-preview | package-2022-09-12-preview(a4620b9) | package-2022-09-12-preview(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L48 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L51 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L54 |
|
value property in pageable response should be requiredLocation: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L61 |
|
Error response should contain a x-ms-error-code header. Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L65 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L90 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L93 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L96 |
|
Schema with type: number should specify format Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L111 |
|
Error response should contain a x-ms-error-code header. Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L115 |
|
OperationId for put method should contain both 'Create' and 'Update' Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L124 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L130 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L133 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L136 |
|
Schema with type: number should specify format Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L147 |
|
Schema with type: number should specify format Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L160 |
|
Schema with type: number should specify format Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L166 |
|
Error response should contain a x-ms-error-code header. Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L170 |
|
'DELETE' operation 'Jobs_Cancel' 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.Quantum/preview/2022-09-12-preview/quantum.json#L179 |
|
OperationId for delete method should contain 'Delete' Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L179 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L185 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L188 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L191 |
|
Error response should contain a x-ms-error-code header. Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L207 |
|
A patch operation should consume 'application/merge-patch+json' content type. Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L215 |
|
OperationId for patch method should contain 'Update' Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L216 |
|
'PATCH' operation 'Jobs_Patch' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L216 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L222 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L225 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L228 |
️️✔️
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.
️❌
SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️
CadlAPIView 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.
️️✔️
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.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger pipeline restarted successfully, please wait for status update in this comment. |
Thank you for your contribution chuanqixu! We will review the pull request and get back to you soon. |
Data Plane API - Pull Request
The current scope for Azure authentication is '<audience>/.default', which is not clear and misleading on some occasions.
I changed it to the absolute URL, which is 'https://quantum.microsoft.com/.default'.
I tested that this is the correct scope for Azure authentication that can acquire the access token.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links