Merge pull request #27911 from aramissennyeydd/openapi-tooling/tags

fix: ensure tags are handled by the generated clients

.changeset/hungry-hairs-wait.md

@@ -0,0 +1,5 @@
+---
+'@backstage/repo-tools': patch
+---
+
+Generated OpenAPI clients now support paths with tags.

.changeset/new-rules-teach.md

@@ -0,0 +1,8 @@
+---
+'@backstage/catalog-client': minor
+'@backstage/plugin-catalog-backend': minor
+'@backstage/plugin-events-backend': minor
+'@backstage/plugin-search-backend': minor
+---
+
+Internal updates to generated code.

packages/catalog-client/src/schema/openapi/generated/apis/Api.client.ts

@@ -22,7 +22,6 @@ import { FetchApi } from '../types/fetch';
 import crossFetch from 'cross-fetch';
 import { pluginId } from '../pluginId';
 import * as parser from 'uri-template';
-
 import { AnalyzeLocationRequest } from '../models/AnalyzeLocationRequest.model';
 import { AnalyzeLocationResponse } from '../models/AnalyzeLocationResponse.model';
 import { CreateLocation201Response } from '../models/CreateLocation201Response.model';
@@ -55,7 +54,6 @@ export type TypedResponse<T> = Omit<Response, 'json'> & {
 export interface RequestOptions {
   token?: string;
 }
-
 /**
  * @public
  */
@@ -197,7 +195,6 @@ export type ValidateEntity = {
 };
 
 /**
- * no description
  * @public
  */
 export class DefaultApiClient {

packages/catalog-client/src/schema/openapi/generated/apis/index.ts

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 
-export * from './DefaultApi.client';
+export * from './Api.client';

packages/repo-tools/src/commands/package/schema/openapi/generate/client.ts

@@ -21,11 +21,13 @@ import {
   OUTPUT_PATH,
 } from '../../../../../lib/openapi/constants';
 import { paths as cliPaths } from '../../../../../lib/paths';
-import { mkdirpSync } from 'fs-extra';
 import fs from 'fs-extra';
 import { exec } from '../../../../../lib/exec';
 import { resolvePackagePath } from '@backstage/backend-plugin-api';
-import { getPathToCurrentOpenApiSpec } from '../../../../../lib/openapi/helpers';
+import {
+  getPathToCurrentOpenApiSpec,
+  toGeneratorAdditionalProperties,
+} from '../../../../../lib/openapi/helpers';
 
 async function generate(
   outputDirectory: string,
@@ -37,12 +39,11 @@ async function generate(
     outputDirectory,
     OUTPUT_PATH,
   );
-  const additionalProperties = clientAdditionalProperties
-    ? `--additional-properties=${clientAdditionalProperties}`
-    : '';
-  mkdirpSync(resolvedOutputDirectory);
+  const additionalProperties = toGeneratorAdditionalProperties({
+    initialValue: clientAdditionalProperties,
+  });
 
-  await fs.mkdirp(resolvedOutputDirectory);
+  await fs.emptyDir(resolvedOutputDirectory);
 
   await fs.writeFile(
     resolve(resolvedOutputDirectory, '.openapi-generator-ignore'),
@@ -67,7 +68,9 @@ async function generate(
       ),
       '--generator-key',
       'v3.0',
-      additionalProperties,
+      additionalProperties
+        ? `--additional-properties=${additionalProperties}`
+        : '',
     ],
     {
       signal: abortSignal?.signal,

packages/repo-tools/src/commands/package/schema/openapi/generate/server.ts

@@ -86,7 +86,7 @@ async function generate(abortSignal?: AbortController) {
   const resolvedOpenapiPath = await getPathToCurrentOpenApiSpec();
   const resolvedOutputDirectory = await getRelativePathToFile(OUTPUT_PATH);
 
-  await fs.mkdirp(resolvedOutputDirectory);
+  await fs.emptyDir(resolvedOutputDirectory);
 
   await fs.writeFile(
     resolve(resolvedOutputDirectory, '.openapi-generator-ignore'),

packages/repo-tools/src/lib/openapi/helpers.ts

@@ -51,3 +51,23 @@ export async function loadAndValidateOpenApiYaml(path: string) {
   await Parser.validate(cloneDeep(yaml) as any);
   return yaml;
 }
+
+export function toGeneratorAdditionalProperties({
+  initialValue,
+  defaultValue,
+}: {
+  initialValue?: string;
+  defaultValue?: Record<string, any>;
+}) {
+  const items = initialValue?.split(',') ?? [];
+  const parsed = items.reduce(
+    (acc, item) => {
+      const [key, value] = item.split('=');
+      return { ...acc, [key]: value };
+    },
+    { ...defaultValue },
+  );
+  return Object.entries(parsed)
+    .map(([key, value]) => `${key}=${value}`)
+    .join(',');
+}

packages/repo-tools/templates/typescript-backstage-client.yaml

@@ -1,10 +1,6 @@
 templateDir: templates/typescript-backstage-client
 
 files:
-  api.mustache:
-    templateType: API
-    # For some reason, they check for destinationFilename differences. We have to change the ending to override the file.
-    destinationFilename: .client.ts
   model.mustache:
     templateType: Model
     destinationFilename: .model.ts
@@ -32,6 +28,9 @@ files:
   apis/index.mustache:
     templateType: SupportingFiles
     destinationFilename: apis/index.ts
+  apis/api-all.mustache:
+    templateType: SupportingFiles
+    destinationFilename: apis/Api.client.ts
   pluginId.mustache:
     templateType: SupportingFiles
     destinationFilename: pluginId.ts

packages/repo-tools/templates/typescript-backstage-client/apis/api-all.mustache

@@ -4,10 +4,12 @@ import { FetchApi } from '../types/fetch';
 import crossFetch from 'cross-fetch';
 import {pluginId} from '../pluginId';
 import * as parser from 'uri-template';
-
+{{#apiInfo}}
+{{#apis}}
 {{#imports}}
 import { {{classname}} } from '{{filename}}.model{{importFileExtension}}';
 {{/imports}}
+{{/apis}}
 
 /**
  * Wraps the Response type to convey a type on the json call.
@@ -18,8 +20,6 @@ export type TypedResponse<T> = Omit<Response, 'json'> & {
   json: () => Promise<T>;
 };
 
-{{#operations}}
-
 /**
  * Options you can pass into a request for additional information.
  *
@@ -28,7 +28,8 @@ export type TypedResponse<T> = Omit<Response, 'json'> & {
 export interface RequestOptions {
   token?: string;
 }
-
+{{#apis}}
+{{#operations}}
 {{#operation}}
 /**
   * @public
@@ -62,12 +63,13 @@ export type {{#lambda.pascalcase}}{{nickname}}{{/lambda.pascalcase}} = {
     {{/hasHeaderParams}}
 }
 {{/operation}}
+{{/operations}}
+{{/apis}}
 
 /**
- * {{{description}}}{{^description}}no description{{/description}}
  * @public
  */
-export class {{classname}}Client {
+export class DefaultApiClient {
     private readonly discoveryApi: DiscoveryApi;
     private readonly fetchApi: FetchApi;
 
@@ -79,6 +81,9 @@ export class {{classname}}Client {
         this.fetchApi = options.fetchApi || { fetch: crossFetch };
     }
 
+    {{#apis}}
+    {{#operations}}
+
     {{#operation}}
     /**
      {{#notes}}
@@ -123,5 +128,7 @@ export class {{classname}}Client {
     }
 
     {{/operation}}
+    {{/operations}}
+    {{/apis}}
 }
-{{/operations}}
+{{/apiInfo}}

packages/repo-tools/templates/typescript-backstage-client/apis/index.mustache

@@ -1,3 +1,3 @@
 //
 
-export * from './DefaultApi.client';
+export * from './Api.client';

packages/repo-tools/templates/typescript-backstage-server.yaml

@@ -1,13 +1,12 @@
 templateDir: templates/typescript-backstage-server
 
 files:
-  api.mustache:
-    templateType: API
-    # For some reason, they check for destinationFilename differences. We have to change the ending to override the file.
-    destinationFilename: .server.ts
   apis/index.mustache:
     templateType: SupportingFiles
     destinationFilename: apis/index.ts
+  apis/api-all.mustache:
+    templateType: SupportingFiles
+    destinationFilename: apis/Api.server.ts
   index.mustache:
     templateType: SupportingFiles
     destinationFilename: index.ts

packages/repo-tools/templates/typescript-backstage-server/apis/api-all.mustache

@@ -1,4 +1,7 @@
+//
 {{>licenseInfo}}
+{{#apiInfo}}
+{{#apis}}
 {{#imports}}
 import { {{classname}} } from '{{filename}}.model{{importFileExtension}}';
 {{/imports}}
@@ -39,16 +42,19 @@ export type {{#lambda.pascalcase}}{{nickname}}{{/lambda.pascalcase}} = {
     response: {{#responses}} {{{dataType}}}{{^dataType}}void{{/dataType}} {{^-last}} | {{/-last}} {{/responses}}
 }
 {{/operation}}
-
-/**
- * {{{description}}}{{^description}}no description{{/description}}
- */
+{{/operations}}
+{{/apis}}
 
 export type EndpointMap = {
+    {{#apis}}
+    {{#operations}}
     {{#operation}}
     
     '#{{#lambda.lowercase}}{{httpMethod}}{{/lambda.lowercase}}|{{path}}': {{#lambda.pascalcase}}{{nickname}}{{/lambda.pascalcase}},
     
     {{/operation}}
+    {{/operations}}
+    {{/apis}}
 }
-{{/operations}}
+
+{{/apiInfo}}

packages/repo-tools/templates/typescript-backstage-server/apis/index.mustache

@@ -1,3 +1,4 @@
 //
+{{>licenseInfo}}
 
-export * from './DefaultApi.server';
+export * from './Api.server'

plugins/catalog-backend/src/schema/openapi/generated/apis/Api.server.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+//
+
 // ******************************************************************
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************
@@ -190,10 +192,6 @@ export type ValidateEntity = {
   response: void | ValidateEntity400Response;
 };
 
-/**
- * no description
- */
-
 export type EndpointMap = {
   '#post|/analyze-location': AnalyzeLocation;
 

plugins/catalog-backend/src/schema/openapi/generated/apis/index.ts

@@ -14,4 +14,10 @@
  * limitations under the License.
  */
 
-export * from './DefaultApi.server';
+//
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+export * from './Api.server';

plugins/events-backend/src/schema/openapi/generated/apis/Api.server.ts

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+//
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { GetSubscriptionEvents200Response } from '../models/GetSubscriptionEvents200Response.model';
+import { PostEventRequest } from '../models/PostEventRequest.model';
+import { PutSubscriptionRequest } from '../models/PutSubscriptionRequest.model';
+
+/**
+ * @public
+ */
+export type GetSubscriptionEvents = {
+  path: {
+    subscriptionId: string;
+  };
+  response: GetSubscriptionEvents200Response | void | Error;
+};
+/**
+ * @public
+ */
+export type PostEvent = {
+  body: PostEventRequest;
+  response: void | void | Error;
+};
+/**
+ * @public
+ */
+export type PutSubscription = {
+  path: {
+    subscriptionId: string;
+  };
+  body: PutSubscriptionRequest;
+  response: void | Error;
+};
+
+export type EndpointMap = {
+  '#get|/bus/v1/subscriptions/{subscriptionId}/events': GetSubscriptionEvents;
+
+  '#post|/bus/v1/events': PostEvent;
+
+  '#put|/bus/v1/subscriptions/{subscriptionId}': PutSubscription;
+};

plugins/events-backend/src/schema/openapi/generated/apis/index.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+//
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+export * from './Api.server';

plugins/events-backend/src/schema/openapi/generated/index.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './apis';
+export * from './router';

plugins/events-backend/src/schema/openapi/generated/models/ErrorError.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface ErrorError {
+  name: string;
+  message: string;
+}

plugins/events-backend/src/schema/openapi/generated/models/ErrorRequest.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface ErrorRequest {
+  method: string;
+  url: string;
+}

plugins/events-backend/src/schema/openapi/generated/models/ErrorResponse.model.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface ErrorResponse {
+  statusCode: number;
+}

plugins/events-backend/src/schema/openapi/generated/models/Event.model.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface Event {
+  /**
+   * The topic that the event is published on
+   */
+  topic: string;
+  /**
+   * The event payload
+   */
+  payload: any | null;
+}

plugins/events-backend/src/schema/openapi/generated/models/GetSubscriptionEvents200Response.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { Event } from '../models/Event.model';
+
+/**
+ * @public
+ */
+export interface GetSubscriptionEvents200Response {
+  events: Array<Event>;
+}

plugins/events-backend/src/schema/openapi/generated/models/ModelError.model.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { ErrorError } from '../models/ErrorError.model';
+import { ErrorRequest } from '../models/ErrorRequest.model';
+import { ErrorResponse } from '../models/ErrorResponse.model';
+
+/**
+ * @public
+ */
+export interface ModelError {
+  error: ErrorError;
+  request: ErrorRequest;
+  response: ErrorResponse;
+}

plugins/events-backend/src/schema/openapi/generated/models/PostEventRequest.model.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { Event } from '../models/Event.model';
+
+/**
+ * @public
+ */
+export interface PostEventRequest {
+  event: Event;
+  /**
+   * The IDs of subscriptions that have already received this event
+   */
+  notifiedSubscribers?: Array<string>;
+}

plugins/events-backend/src/schema/openapi/generated/models/PutSubscriptionRequest.model.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface PutSubscriptionRequest {
+  /**
+   * The topics to subscribe to
+   */
+  topics: Array<string>;
+}

plugins/events-backend/src/schema/openapi/generated/models/index.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from '../models/ErrorError.model';
+export * from '../models/ErrorRequest.model';
+export * from '../models/ErrorResponse.model';
+export * from '../models/Event.model';
+export * from '../models/GetSubscriptionEvents200Response.model';
+export * from '../models/ModelError.model';
+export * from '../models/PostEventRequest.model';
+export * from '../models/PutSubscriptionRequest.model';

plugins/events-backend/src/schema/openapi/generated/router.ts

@@ -17,7 +17,8 @@
 // ******************************************************************
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************
-import { createValidatedOpenApiRouter } from '@backstage/backend-openapi-utils';
+import { createValidatedOpenApiRouterFromGeneratedEndpointMap } from '@backstage/backend-openapi-utils';
+import { EndpointMap } from './';
 
 export const spec = {
   openapi: '3.0.3',
@@ -287,5 +288,11 @@ export const spec = {
   },
 } as const;
 export const createOpenApiRouter = async (
-  options?: Parameters<typeof createValidatedOpenApiRouter>['1'],
-) => createValidatedOpenApiRouter<typeof spec>(spec, options);
+  options?: Parameters<
+    typeof createValidatedOpenApiRouterFromGeneratedEndpointMap
+  >['1'],
+) =>
+  createValidatedOpenApiRouterFromGeneratedEndpointMap<EndpointMap>(
+    spec,
+    options,
+  );

plugins/events-backend/src/schema/openapi/index.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './generated';

plugins/events-backend/src/service/hub/createEventBusRouter.ts

@@ -22,7 +22,7 @@ import {
   SchedulerService,
 } from '@backstage/backend-plugin-api';
 import { Handler } from 'express';
-import { createOpenApiRouter } from '../../schema/openapi.generated';
+import { createOpenApiRouter } from '../../schema/openapi';
 import { MemoryEventBusStore } from './MemoryEventBusStore';
 import { DatabaseEventBusStore } from './DatabaseEventBusStore';
 import { EventBusStore } from './types';

plugins/events-node/src/schema/openapi/generated/apis/Api.client.ts

@@ -0,0 +1,163 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { DiscoveryApi } from '../types/discovery';
+import { FetchApi } from '../types/fetch';
+import crossFetch from 'cross-fetch';
+import { pluginId } from '../pluginId';
+import * as parser from 'uri-template';
+import { GetSubscriptionEvents200Response } from '../models/GetSubscriptionEvents200Response.model';
+import { PostEventRequest } from '../models/PostEventRequest.model';
+import { PutSubscriptionRequest } from '../models/PutSubscriptionRequest.model';
+
+/**
+ * Wraps the Response type to convey a type on the json call.
+ *
+ * @public
+ */
+export type TypedResponse<T> = Omit<Response, 'json'> & {
+  json: () => Promise<T>;
+};
+
+/**
+ * Options you can pass into a request for additional information.
+ *
+ * @public
+ */
+export interface RequestOptions {
+  token?: string;
+}
+/**
+ * @public
+ */
+export type GetSubscriptionEvents = {
+  path: {
+    subscriptionId: string;
+  };
+};
+/**
+ * @public
+ */
+export type PostEvent = {
+  body: PostEventRequest;
+};
+/**
+ * @public
+ */
+export type PutSubscription = {
+  path: {
+    subscriptionId: string;
+  };
+  body: PutSubscriptionRequest;
+};
+
+/**
+ * @public
+ */
+export class DefaultApiClient {
+  private readonly discoveryApi: DiscoveryApi;
+  private readonly fetchApi: FetchApi;
+
+  constructor(options: {
+    discoveryApi: { getBaseUrl(pluginId: string): Promise<string> };
+    fetchApi?: { fetch: typeof fetch };
+  }) {
+    this.discoveryApi = options.discoveryApi;
+    this.fetchApi = options.fetchApi || { fetch: crossFetch };
+  }
+
+  /**
+   * Get new events for the provided subscription
+   * @param subscriptionId -
+   */
+  public async getSubscriptionEvents(
+    // @ts-ignore
+    request: GetSubscriptionEvents,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<void | GetSubscriptionEvents200Response>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/bus/v1/subscriptions/{subscriptionId}/events`;
+
+    const uri = parser.parse(uriTemplate).expand({
+      subscriptionId: request.path.subscriptionId,
+    });
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'GET',
+    });
+  }
+
+  /**
+   * Publish a new event
+   * @param postEventRequest -
+   */
+  public async postEvent(
+    // @ts-ignore
+    request: PostEvent,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<void>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/bus/v1/events`;
+
+    const uri = parser.parse(uriTemplate).expand({});
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'POST',
+      body: JSON.stringify(request.body),
+    });
+  }
+
+  /**
+   * Ensures that the subscription exists with the provided configuration
+   * @param subscriptionId -
+   * @param putSubscriptionRequest -
+   */
+  public async putSubscription(
+    // @ts-ignore
+    request: PutSubscription,
+    options?: RequestOptions,
+  ): Promise<TypedResponse<void>> {
+    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
+
+    const uriTemplate = `/bus/v1/subscriptions/{subscriptionId}`;
+
+    const uri = parser.parse(uriTemplate).expand({
+      subscriptionId: request.path.subscriptionId,
+    });
+
+    return await this.fetchApi.fetch(`${baseUrl}${uri}`, {
+      headers: {
+        'Content-Type': 'application/json',
+        ...(options?.token && { Authorization: `Bearer ${options?.token}` }),
+      },
+      method: 'PUT',
+      body: JSON.stringify(request.body),
+    });
+  }
+}

plugins/events-node/src/schema/openapi/generated/apis/index.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './Api.client';

plugins/events-node/src/schema/openapi/generated/index.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './apis';
+export * from './models';

plugins/events-node/src/schema/openapi/generated/models/ErrorError.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface ErrorError {
+  name: string;
+  message: string;
+}

plugins/events-node/src/schema/openapi/generated/models/ErrorRequest.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface ErrorRequest {
+  method: string;
+  url: string;
+}

plugins/events-node/src/schema/openapi/generated/models/ErrorResponse.model.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface ErrorResponse {
+  statusCode: number;
+}

plugins/events-node/src/schema/openapi/generated/models/Event.model.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface Event {
+  /**
+   * The topic that the event is published on
+   */
+  topic: string;
+  /**
+   * The event payload
+   */
+  payload: any | null;
+}

plugins/events-node/src/schema/openapi/generated/models/GetSubscriptionEvents200Response.model.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { Event } from '../models/Event.model';
+
+/**
+ * @public
+ */
+export interface GetSubscriptionEvents200Response {
+  events: Array<Event>;
+}

plugins/events-node/src/schema/openapi/generated/models/ModelError.model.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { ErrorError } from '../models/ErrorError.model';
+import { ErrorRequest } from '../models/ErrorRequest.model';
+import { ErrorResponse } from '../models/ErrorResponse.model';
+
+/**
+ * @public
+ */
+export interface ModelError {
+  error: ErrorError;
+  request: ErrorRequest;
+  response: ErrorResponse;
+}

plugins/events-node/src/schema/openapi/generated/models/PostEventRequest.model.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import { Event } from '../models/Event.model';
+
+/**
+ * @public
+ */
+export interface PostEventRequest {
+  event: Event;
+  /**
+   * The IDs of subscriptions that have already received this event
+   */
+  notifiedSubscribers?: Array<string>;
+}

plugins/events-node/src/schema/openapi/generated/models/PutSubscriptionRequest.model.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+/**
+ * @public
+ */
+export interface PutSubscriptionRequest {
+  /**
+   * The topics to subscribe to
+   */
+  topics: Array<string>;
+}

plugins/events-node/src/schema/openapi/generated/models/index.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from '../models/ErrorError.model';
+export * from '../models/ErrorRequest.model';
+export * from '../models/ErrorResponse.model';
+export * from '../models/Event.model';
+export * from '../models/GetSubscriptionEvents200Response.model';
+export * from '../models/ModelError.model';
+export * from '../models/PostEventRequest.model';
+export * from '../models/PutSubscriptionRequest.model';

plugins/events-node/src/schema/openapi/generated/pluginId.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export const pluginId = 'events';

plugins/events-node/src/schema/openapi/generated/types/discovery.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * This is a copy of the DiscoveryApi, to avoid importing core-plugin-api.
+ */
+export type DiscoveryApi = {
+  getBaseUrl(pluginId: string): Promise<string>;
+};

plugins/events-node/src/schema/openapi/generated/types/fetch.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * This is a copy of FetchApi, to avoid importing core-plugin-api.
+ */
+export type FetchApi = {
+  fetch: typeof fetch;
+};

plugins/events-node/src/schema/openapi/index.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './generated';

plugins/search-backend/src/schema/openapi.yaml

@@ -175,4 +175,4 @@ paths:
           allowReserved: true
           schema:
             type: object
-            additionalProperties: true
+            additionalProperties: {}

plugins/search-backend/src/schema/openapi/generated/apis/Api.server.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+//
+
 // ******************************************************************
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************
@@ -29,14 +31,11 @@ export type Query = {
     types?: Array<string>;
     pageCursor?: string;
     pageLimit?: number;
+    unknown?: { [key: string]: any };
   };
   response: Query200Response | Error;
 };
 
-/**
- * no description
- */
-
 export type EndpointMap = {
   '#get|/query': Query;
 };

plugins/search-backend/src/schema/openapi/generated/apis/index.ts

@@ -14,4 +14,10 @@
  * limitations under the License.
  */
 
-export * from './DefaultApi.server';
+//
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+
+export * from './Api.server';

plugins/search-backend/src/schema/openapi/generated/router.ts

@@ -253,7 +253,7 @@ export const spec = {
             allowReserved: true,
             schema: {
               type: 'object',
-              additionalProperties: true,
+              additionalProperties: {},
             },
           },
         ],