-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[EngSys] Generate subpath export review files (#28730)
### Packages impacted by this PR @azure/notifications-hub ### Issues associated with this PR Contributes to #28750 but completion requires updating all the packages to use this ### Describe the problem that is addressed by this PR Building off of @jeremymeng's work in #27646, this PR configures API review files for packages containing subpath exports. While APIView is not yet ready to support multiple json files, this provides us with appropriate API reviews tracking any public API changes. Follow-up PRs will add support for this in APIView, but this feels like a quick win and step forward. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? A few alternatives, and I am open to feedback: 1. Update the EngSys script to allow multiple DocModel json files - I chose to go with a flag to disable generating them instead, so that we can build off of it in pieces 2. File naming convention - I already got and applied some feedback on that, thanks Timo
- Loading branch information
Showing
6 changed files
with
1,244 additions
and
30 deletions.
There are no files selected for viewing
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
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
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
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
99 changes: 99 additions & 0 deletions
99
sdk/notificationhubs/notification-hubs/review/notification-hubs-api.api.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| ## API Report File for "@azure/notification-hubs" | ||
|
|
||
| > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). | ||
| ```ts | ||
|
|
||
| /// <reference types="node" /> | ||
|
|
||
| import { ClientOptions } from '@azure-rest/core-client'; | ||
| import { HttpHeaders } from '@azure/core-rest-pipeline'; | ||
| import { OperationOptions } from '@azure-rest/core-client'; | ||
| import { OperationState } from '@azure/core-lro'; | ||
| import { PagedAsyncIterableIterator } from '@azure/core-paging'; | ||
| import { PipelineRequest } from '@azure/core-rest-pipeline'; | ||
| import { PipelineResponse } from '@azure/core-rest-pipeline'; | ||
| import { SimplePollerLike } from '@azure/core-lro'; | ||
|
|
||
| // @public | ||
| export function beginSubmitNotificationHubJob(context: NotificationHubsClientContext, notificationHubJob: NotificationHubJob, polledOperationOptions?: PolledOperationOptions): Promise<NotificationHubJobPoller>; | ||
|
|
||
| // @public | ||
| export function cancelScheduledNotification(context: NotificationHubsClientContext, notificationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>; | ||
|
|
||
| // @public | ||
| export function createClientContext(connectionString: string, hubName: string, options?: NotificationHubsClientOptions): NotificationHubsClientContext; | ||
|
|
||
| // @public | ||
| export function createOrUpdateInstallation(context: NotificationHubsClientContext, installation: Installation, options?: OperationOptions): Promise<NotificationHubsResponse>; | ||
|
|
||
| // @public | ||
| export function createOrUpdateRegistration(context: NotificationHubsClientContext, registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>; | ||
|
|
||
| // @public | ||
| export function createRegistration(context: NotificationHubsClientContext, registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>; | ||
|
|
||
| // @public | ||
| export function createRegistrationId(context: NotificationHubsClientContext, options?: OperationOptions): Promise<string>; | ||
|
|
||
| // @public | ||
| export function deleteInstallation(context: NotificationHubsClientContext, installationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>; | ||
|
|
||
| // @public | ||
| export function deleteRegistration(context: NotificationHubsClientContext, registrationId: string, options?: EntityOperationOptions): Promise<NotificationHubsResponse>; | ||
|
|
||
| // @public | ||
| export function getFeedbackContainerUrl(context: NotificationHubsClientContext, options?: OperationOptions): Promise<string>; | ||
|
|
||
| // @public | ||
| export function getInstallation(context: NotificationHubsClientContext, installationId: string, options?: OperationOptions): Promise<Installation>; | ||
|
|
||
| // @public | ||
| export function getNotificationHubJob(context: NotificationHubsClientContext, jobId: string, options?: OperationOptions): Promise<NotificationHubJob>; | ||
|
|
||
| // @public | ||
| export function getNotificationOutcomeDetails(context: NotificationHubsClientContext, notificationId: string, options?: OperationOptions): Promise<NotificationDetails>; | ||
|
|
||
| // @public | ||
| export function getRegistration(context: NotificationHubsClientContext, registrationId: string, options?: OperationOptions): Promise<RegistrationDescription>; | ||
|
|
||
| // @public | ||
| export function listNotificationHubJobs(context: NotificationHubsClientContext, options?: OperationOptions): Promise<NotificationHubJob[]>; | ||
|
|
||
| // @public | ||
| export function listRegistrations(context: NotificationHubsClientContext, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription>; | ||
|
|
||
| // @public | ||
| export function listRegistrationsByChannel(context: NotificationHubsClientContext, channel: RegistrationChannel, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription>; | ||
|
|
||
| // @public | ||
| export function listRegistrationsByTag(context: NotificationHubsClientContext, tag: string, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription>; | ||
|
|
||
| // @public | ||
| export interface NotificationHubsClientContext { | ||
| // @internal (undocumented) | ||
| createHeaders(operationName: string, rawHeaders?: Record<string, string>): Promise<HttpHeaders>; | ||
| // @internal (undocumented) | ||
| requestUrl(): URL; | ||
| // @internal (undocumented) | ||
| sendRequest(request: PipelineRequest): Promise<PipelineResponse>; | ||
| } | ||
|
|
||
| // @public | ||
| export function scheduleNotification(context: NotificationHubsClientContext, scheduledTime: Date, notification: Notification, options?: ScheduleNotificationOptions): Promise<NotificationHubsMessageResponse>; | ||
|
|
||
| // @public | ||
| export function sendNotification(context: NotificationHubsClientContext, notification: Notification, options?: DirectSendNotificationOptions | SendNotificationOptions): Promise<NotificationHubsMessageResponse>; | ||
|
|
||
| // @public | ||
| export function submitNotificationHubJob(context: NotificationHubsClientContext, job: NotificationHubJob, options?: OperationOptions): Promise<NotificationHubJob>; | ||
|
|
||
| // @public | ||
| export function updateInstallation(context: NotificationHubsClientContext, installationId: string, installationPatches: JsonPatch[], options?: OperationOptions): Promise<NotificationHubsResponse>; | ||
|
|
||
| // @public | ||
| export function updateRegistration(context: NotificationHubsClientContext, registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>; | ||
|
|
||
| // (No @packageDocumentation comment for this package) | ||
|
|
||
| ``` |
Oops, something went wrong.