paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 31 Packages Projects Releases Wiki Activity

chore: fix api-reports warnings

Browse Source 
Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-10-14 17:56:00 +02:00
parent 35e735bb55
commit fc01ce7e77
216 changed files with 28 additions and 4221 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/events-node/report-alpha.api.md
-9
View File
@@ -28,14 +28,5 @@ export interface EventsExtensionPoint {
// @alpha (undocumented)
export const eventsExtensionPoint: ExtensionPoint<EventsExtensionPoint>;
// Warnings were encountered during analysis:
//
// src/extensions.d.ts:5:1 - (ae-undocumented) Missing documentation for "EventsExtensionPoint".
// src/extensions.d.ts:9:5 - (ae-undocumented) Missing documentation for "setEventBroker".
// src/extensions.d.ts:13:5 - (ae-undocumented) Missing documentation for "addPublishers".
// src/extensions.d.ts:17:5 - (ae-undocumented) Missing documentation for "addSubscribers".
// src/extensions.d.ts:18:5 - (ae-undocumented) Missing documentation for "addHttpPostIngress".
// src/extensions.d.ts:23:22 - (ae-undocumented) Missing documentation for "eventsExtensionPoint".
// (No @packageDocumentation comment for this package)
```
plugins/events-node/report.api.md
-22
View File
@@ -139,26 +139,4 @@ export abstract class SubTopicEventRouter extends EventRouter {
// (undocumented)
protected abstract determineSubTopic(params: EventParams): string | undefined;
}
// Warnings were encountered during analysis:
//
// src/api/DefaultEventsService.d.ts:16:5 - (ae-undocumented) Missing documentation for "create".
// src/api/DefaultEventsService.d.ts:31:5 - (ae-undocumented) Missing documentation for "publish".
// src/api/DefaultEventsService.d.ts:32:5 - (ae-undocumented) Missing documentation for "subscribe".
// src/api/EventParams.d.ts:4:1 - (ae-undocumented) Missing documentation for "EventParams".
// src/api/EventPublisher.d.ts:15:5 - (ae-undocumented) Missing documentation for "setEventBroker".
// src/api/EventRouter.d.ts:18:5 - (ae-undocumented) Missing documentation for "getSubscriberId".
// src/api/EventRouter.d.ts:19:5 - (ae-undocumented) Missing documentation for "determineDestinationTopic".
// src/api/EventRouter.d.ts:26:5 - (ae-undocumented) Missing documentation for "onEvent".
// src/api/EventsService.d.ts:26:1 - (ae-undocumented) Missing documentation for "EventsServiceSubscribeOptions".
// src/api/EventsService.d.ts:37:1 - (ae-undocumented) Missing documentation for "EventsServiceEventHandler".
// src/api/SubTopicEventRouter.d.ts:18:5 - (ae-undocumented) Missing documentation for "determineSubTopic".
// src/api/SubTopicEventRouter.d.ts:19:5 - (ae-undocumented) Missing documentation for "determineDestinationTopic".
// src/api/http/HttpPostIngressOptions.d.ts:5:1 - (ae-undocumented) Missing documentation for "HttpPostIngressOptions".
// src/api/http/HttpPostIngressOptions.d.ts:6:5 - (ae-undocumented) Missing documentation for "topic".
// src/api/http/HttpPostIngressOptions.d.ts:7:5 - (ae-undocumented) Missing documentation for "validator".
// src/api/http/validation/RequestDetails.d.ts:4:1 - (ae-undocumented) Missing documentation for "RequestDetails".
// src/api/http/validation/RequestRejectionDetails.d.ts:8:5 - (ae-undocumented) Missing documentation for "status".
// src/api/http/validation/RequestRejectionDetails.d.ts:9:5 - (ae-undocumented) Missing documentation for "payload".
// src/service.d.ts:10:22 - (ae-undocumented) Missing documentation for "eventsServiceFactory".
```