Skip to content
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

Merged
merged 1 commit into from
May 30, 2023

Conversation

chuanqixu
Copy link
Contributor

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.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

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.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

❔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

@chuanqixu chuanqixu requested a review from a team as a code owner May 30, 2023 00:12
@chuanqixu chuanqixu requested review from tg-msft and scgbear and removed request for a team May 30, 2023 00:12
@openapi-workflow-bot
Copy link

Hi, @chuanqixu Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 30, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    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
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L48
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L51
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L54
    ⚠️ PaginationResponse value property in pageable response should be required
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L61
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L65
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L90
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L93
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L96
    ⚠️ SchemaTypeAndFormat Schema with type: number should specify format
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L111
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L115
    ⚠️ OperationId OperationId for put method should contain both 'Create' and 'Update'
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L124
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L130
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L133
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L136
    ⚠️ SchemaTypeAndFormat Schema with type: number should specify format
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L147
    ⚠️ SchemaTypeAndFormat Schema with type: number should specify format
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L160
    ⚠️ SchemaTypeAndFormat Schema with type: number should specify format
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L166
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L170
    ⚠️ DeleteInOperationName '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 OperationId for delete method should contain 'Delete'
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L179
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L185
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L188
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L191
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L207
    ⚠️ PatchContentType A patch operation should consume 'application/merge-patch+json' content type.
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L215
    ⚠️ OperationId OperationId for patch method should contain 'Update'
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L216
    ⚠️ PatchInOperationName '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
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L222
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Quantum/preview/2022-09-12-preview/quantum.json#L225
    ⚠️ PathParameterSchema 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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 30, 2023

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 30, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.Quantum Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label May 30, 2023
    @ghost
    Copy link

    ghost commented May 30, 2023

    Thank you for your contribution chuanqixu! We will review the pull request and get back to you soon.

    @tjprescott tjprescott merged commit 44fe78f into Azure:main May 30, 2023
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    customer-reported Issues that are reported by GitHub users external to the Azure organization. data-plane
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants