add missing docstrings

Signed-off-by: Johan Haals <johan.haals@gmail.com>

packages/backend-plugin-api/src/services/definitions/cacheServiceRef.ts

@@ -17,6 +17,9 @@
 import { createServiceRef } from '../system/types';
 import { PluginCacheManager } from '@backstage/backend-common';
 
+/**
+ * @public
+ */
 export const cacheServiceRef = createServiceRef<PluginCacheManager>({
   id: 'core.cache',
 });

packages/backend-plugin-api/src/services/definitions/configServiceRef.ts

@@ -17,6 +17,9 @@
 import { Config } from '@backstage/config';
 import { createServiceRef } from '../system/types';
 
+/**
+ * @public
+ */
 export const configServiceRef = createServiceRef<Config>({
   id: 'core.config',
 });

packages/backend-plugin-api/src/services/definitions/databaseServiceRef.ts

@@ -17,6 +17,9 @@
 import { PluginDatabaseManager } from '@backstage/backend-common';
 import { createServiceRef } from '../system/types';
 
+/**
+ * @public
+ */
 export const databaseServiceRef = createServiceRef<PluginDatabaseManager>({
   id: 'core.database',
 });

packages/backend-plugin-api/src/services/definitions/discoveryServiceRef.ts

@@ -17,6 +17,9 @@
 import { createServiceRef } from '../system/types';
 import { PluginEndpointDiscovery } from '@backstage/backend-common';
 
+/**
+ * @public
+ */
 export const discoveryServiceRef = createServiceRef<PluginEndpointDiscovery>({
   id: 'core.discovery',
 });

packages/backend-plugin-api/src/services/definitions/httpRouterServiceRef.ts

@@ -17,28 +17,16 @@
 import { createServiceRef } from '../system/types';
 import { Handler } from 'express';
 
-//   const apiRouter = Router();
-//  apiRouter.use('/catalog', await catalog(catalogEnv));
-// const service = createServiceBuilder(module)
-// .loadConfig(config)
-// .addRouter('', await healthcheck(healthcheckEnv))
-// .addRouter('', metricsHandler())
-// .addRouter('/api', apiRouter)
-// .addRouter('', await app(appEnv));
-
-// interface BackstageRequest extends Request {
-//   identity?: BackstageIdentity;
-//   context?: Context;
-// }
-
-// interface RequestIdentityService {
-//   getRequestIdentity(req: Request): BackstageIdentity | undefined;
-// }
-
+/**
+ * @public
+ */
 export interface HttpRouterService {
   use(handler: Handler): void;
 }
 
+/**
+ * @public
+ */
 export const httpRouterServiceRef = createServiceRef<HttpRouterService>({
   id: 'core.httpRouter',
 });

packages/backend-plugin-api/src/services/definitions/index.ts

@@ -14,18 +14,6 @@
  * limitations under the License.
  */
 
-// export type PluginEnvironment = {
-//   logger: Logger;
-//   cache: PluginCacheManager;
-//   database: PluginDatabaseManager;
-//   config: Config;
-//   reader: UrlReader;
-//   discovery: PluginEndpointDiscovery;
-//   tokenManager: TokenManager;
-//   permissions: PermissionEvaluator | PermissionAuthorizer;
-//   scheduler: PluginTaskScheduler;
-// };
-
 export { configServiceRef } from './configServiceRef';
 export { httpRouterServiceRef } from './httpRouterServiceRef';
 export type { HttpRouterService } from './httpRouterServiceRef';

packages/backend-plugin-api/src/services/definitions/loggerServiceRef.ts

@@ -16,11 +16,17 @@
 
 import { createServiceRef } from '../system/types';
 
+/**
+ * @public
+ */
 export interface Logger {
   info(message: string): void;
   child(fields: { [name: string]: string }): Logger;
 }
 
+/**
+ * @public
+ */
 export const loggerServiceRef = createServiceRef<Logger>({
   id: 'core.logger',
 });

packages/backend-plugin-api/src/services/definitions/permissionsServiceRef.ts

@@ -20,6 +20,9 @@ import {
   PermissionEvaluator,
 } from '@backstage/plugin-permission-common';
 
+/**
+ * @public
+ */
 export const permissionsServiceRef = createServiceRef<
   PermissionEvaluator | PermissionAuthorizer
 >({

packages/backend-plugin-api/src/services/definitions/schedulerServiceRef.ts

@@ -17,6 +17,9 @@
 import { createServiceRef } from '../system/types';
 import { PluginTaskScheduler } from '@backstage/backend-tasks';
 
+/**
+ * @public
+ */
 export const schedulerServiceRef = createServiceRef<PluginTaskScheduler>({
   id: 'core.scheduler',
 });

packages/backend-plugin-api/src/services/definitions/scheldulerServiceRef.ts

@@ -20,6 +20,9 @@ import {
   PermissionEvaluator,
 } from '@backstage/plugin-permission-common';
 
+/**
+ * @public
+ */
 export const permissionsServiceRef = createServiceRef<
   PermissionEvaluator | PermissionAuthorizer
 >({

packages/backend-plugin-api/src/services/definitions/tokenManagerServiceRef.ts

@@ -17,6 +17,9 @@
 import { createServiceRef } from '../system/types';
 import { TokenManager } from '@backstage/backend-common';
 
+/**
+ * @public
+ */
 export const tokenManagerServiceRef = createServiceRef<TokenManager>({
   id: 'core.tokenManager',
 });

packages/backend-plugin-api/src/services/definitions/urlReaderServiceRef.ts

@@ -17,6 +17,9 @@
 import { createServiceRef } from '../system/types';
 import { UrlReader } from '@backstage/backend-common';
 
+/**
+ * @public
+ */
 export const urlReaderServiceRef = createServiceRef<UrlReader>({
   id: 'core.urlReader',
 });

packages/backend-plugin-api/src/services/system/types.ts

@@ -56,6 +56,9 @@ export type AnyServiceFactory = ServiceFactory<
   { [key in string]: unknown }
 >;
 
+/**
+ * @public
+ */
 export function createServiceRef<T>(options: { id: string }): ServiceRef<T> {
   return {
     id: options.id,
@@ -69,6 +72,9 @@ export function createServiceRef<T>(options: { id: string }): ServiceRef<T> {
   };
 }
 
+/**
+ * @public
+ */
 export function createServiceFactory<
   Api,
   Impl extends Api,