Skip to content

[notification hubs] Adding TypeSpec for Notification Hubs #23660

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mpodwysocki
Copy link
Contributor

Data Plane API - Pull Request

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

@openapi-workflow-bot
Copy link

Hi, @mpodwysocki 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 Apr 20, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️❌SwaggerAPIView: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    Failed to generate swagger APIView. The readme file format is invalid and the tag is not defined. Use the provided readme template for guidance readme template. For more details, please check the detail log. "How to fix":"Check the readme file and make sure the readme file format is valid and the tag is defined. Use the provided readme template"
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️❌TypeSpecAPIView: 0 Errors, 1 Warnings failed [Detail]
    Rule Message
    ⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest. "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
    ️️✔️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: 113 Errors, 0 Warnings failed [Detail]

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    HowToFix Unknown word (codemodel), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L23:29
    HowToFix Unknown word (codemodel), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L35:29
    HowToFix Unknown word (codemodel), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L200:20
    HowToFix Unknown word (globby), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L304:10
    HowToFix Unknown word (picocolors), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L310:10
    HowToFix Unknown word (universalify), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L366:10
    HowToFix Unknown word (dabh), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L423:20
    HowToFix Unknown word (kuler), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L430:10
    HowToFix Unknown word (regexpp), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L447:37
    HowToFix Unknown word (espree), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L462:10
    HowToFix Unknown word (humanwhocodes), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L505:20
    HowToFix Unknown word (humanwhocodes), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L510:11
    HowToFix Unknown word (humanwhocodes), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L518:20
    HowToFix Unknown word (humanwhocodes), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L530:20
    HowToFix Unknown word (nodelib), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L535:20
    HowToFix Unknown word (scandir), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L535:31
    HowToFix Unknown word (nodelib), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L540:11
    HowToFix Unknown word (nodelib), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L547:20
    HowToFix Unknown word (nodelib), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L555:20
    HowToFix Unknown word (scandir), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L560:22
    HowToFix Unknown word (fastq), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L561:10
    HowToFix Unknown word (rushstack), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L567:20
    HowToFix Unknown word (regexpp), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L627:28
    HowToFix Unknown word (opencollective), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L642:18
    HowToFix Unknown word (estree), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L662:40
    HowToFix Unknown word (opencollective), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L669:18
    HowToFix Unknown word (opencollective), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L693:18
    HowToFix Unknown word (estree), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L702:40
    HowToFix Unknown word (opencollective), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L711:18
    HowToFix Unknown word (estree), please fix the error or add words to ./custom-words.txt
    path: specification/notificationhubs/NotificationHubs/package-lock.json#L735:49
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️❌TypeSpec Validation: 3 Errors, 2 Warnings failed [Detail]
    Rule Message
    import-not-found Couldn't resolve import "./models/feedback.tsp"
    Location: specification/notificationhubs/NotificationHubs/main.tsp#L8
    unknown-identifier Unknown identifier FeedbackContainerResponse
    Location: specification/notificationhubs/NotificationHubs/main.tsp#L90
    MissingExamplesDirectory "details":"The 'examples' directory is missing in the typespec folder specification/notificationhubs/NotificationHubs,
    please ensure the 'examples' is added in the PR."
    ⚠️ MissingTypeSpecProjectConfig "details":"The configuration 'output-file' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/notificationhubs/NotificationHubs,
    please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'."
    ⚠️ MissingTypeSpecProjectConfig "details":"The configuration 'azure-resource-provider-folder' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/notificationhubs/NotificationHubs,
    please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'."
    ️️✔️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 Apr 20, 2023

    Swagger Generation Artifacts

    ️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=358500&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
    "detail":"Run.ps1 failed with exit code 1 "
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️🔄 azure-sdk-for-js inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the Notification Hub label Apr 20, 2023
    @openapi-pipeline-app
    Copy link

    Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant