add public tag to comments

Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com> Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2024-04-01 09:33:01 -04:00
parent 9702f41938
commit 92051737af
45 changed files with 883 additions and 124 deletions
@@ -0,0 +1,621 @@
+## API Report File for "@backstage/catalog-client"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+// Warning: (ae-missing-release-tag) "AnalyzeLocationEntityField" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface AnalyzeLocationEntityField {
+  description: string;
+  field: string;
+  state: AnalyzeLocationEntityFieldStateEnum;
+  // (undocumented)
+  value: string | null;
+}
+
+// Warning: (ae-missing-release-tag) "AnalyzeLocationEntityFieldStateEnum" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type AnalyzeLocationEntityFieldStateEnum =
+  | 'analysisSuggestedValue'
+  | 'analysisSuggestedNoValue'
+  | 'needsUserInput';
+
+// Warning: (ae-missing-release-tag) "AnalyzeLocationExistingEntity" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface AnalyzeLocationExistingEntity {
+  // (undocumented)
+  entity: Entity;
+  // (undocumented)
+  isRegistered: boolean;
+  // (undocumented)
+  location: LocationSpec;
+}
+
+// Warning: (ae-missing-release-tag) "AnalyzeLocationGenerateEntity" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface AnalyzeLocationGenerateEntity {
+  // (undocumented)
+  entity: RecursivePartialEntity;
+  // (undocumented)
+  fields: Array<AnalyzeLocationEntityField>;
+}
+
+// Warning: (ae-missing-release-tag) "AnalyzeLocationRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface AnalyzeLocationRequest {
+  // (undocumented)
+  catalogFileName?: string;
+  // (undocumented)
+  location: LocationInput;
+}
+
+// Warning: (ae-missing-release-tag) "AnalyzeLocationResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface AnalyzeLocationResponse {
+  // (undocumented)
+  existingEntityFiles: Array<AnalyzeLocationExistingEntity>;
+  // (undocumented)
+  generateEntities: Array<AnalyzeLocationGenerateEntity>;
+}
+
+// Warning: (ae-missing-release-tag) "CreateLocation201Response" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface CreateLocation201Response {
+  // (undocumented)
+  entities: Array<Entity>;
+  // (undocumented)
+  exists?: boolean;
+  // (undocumented)
+  location: Location_2;
+}
+
+// Warning: (ae-missing-release-tag) "CreateLocationRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface CreateLocationRequest {
+  // (undocumented)
+  target: string;
+  // (undocumented)
+  type: string;
+}
+
+// Warning: (ae-missing-release-tag) "DefaultApiClient" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export class DefaultApiClient {
+  constructor(options: {
+    discoveryApi: {
+      getBaseUrl(pluginId: string): Promise<string>;
+    };
+    fetchApi?: {
+      fetch: typeof fetch;
+    };
+  });
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  analyzeLocation(
+    request: {
+      body: AnalyzeLocationRequest;
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<AnalyzeLocationResponse>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  createLocation(
+    request: {
+      body: CreateLocationRequest;
+      query: {
+        dryRun?: string;
+      };
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<CreateLocation201Response>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  deleteEntityByUid(
+    request: {
+      path: {
+        uid: string;
+      };
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<void>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  deleteLocation(
+    request: {
+      path: {
+        id: string;
+      };
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<void>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  getEntities(
+    request: {
+      query: {
+        fields?: Array<string>;
+        limit?: number;
+        filter?: Array<string>;
+        offset?: number;
+        after?: string;
+        order?: Array<string>;
+      };
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<Array<Entity>>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  getEntitiesByQuery(
+    request: {
+      query: {
+        fields?: Array<string>;
+        limit?: number;
+        orderField?: Array<string>;
+        cursor?: string;
+        filter?: Array<string>;
+        fullTextFilterTerm?: string;
+        fullTextFilterFields?: Array<string>;
+      };
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<EntitiesQueryResponse>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  getEntitiesByRefs(
+    request: {
+      body: GetEntitiesByRefsRequest;
+      query: {
+        filter?: Array<string>;
+      };
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<EntitiesBatchResponse>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  getEntityAncestryByName(
+    request: {
+      path: {
+        kind: string;
+        namespace: string;
+        name: string;
+      };
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<EntityAncestryResponse>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  getEntityByName(
+    request: {
+      path: {
+        kind: string;
+        namespace: string;
+        name: string;
+      };
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<Entity>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  getEntityByUid(
+    request: {
+      path: {
+        uid: string;
+      };
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<Entity>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  getEntityFacets(
+    request: {
+      query: {
+        facet: Array<string>;
+        filter?: Array<string>;
+      };
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<EntityFacetsResponse>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  getLocation(
+    request: {
+      path: {
+        id: string;
+      };
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<Location_2>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  getLocationByEntity(
+    request: {
+      path: {
+        kind: string;
+        namespace: string;
+        name: string;
+      };
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<Location_2>>;
+  getLocations(
+    request: {},
+    options?: RequestOptions,
+  ): Promise<TypedResponse<Array<GetLocations200ResponseInner>>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  refreshEntity(
+    request: {
+      body: RefreshEntityRequest;
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<void>>;
+  // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
+  validateEntity(
+    request: {
+      body: ValidateEntityRequest;
+    },
+    options?: RequestOptions,
+  ): Promise<TypedResponse<void>>;
+}
+
+// Warning: (ae-missing-release-tag) "EntitiesBatchResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface EntitiesBatchResponse {
+  items: Array<NullableEntity>;
+}
+
+// Warning: (ae-missing-release-tag) "EntitiesQueryResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface EntitiesQueryResponse {
+  items: Array<Entity>;
+  // (undocumented)
+  pageInfo: EntitiesQueryResponsePageInfo;
+  // (undocumented)
+  totalItems: number;
+}
+
+// Warning: (ae-missing-release-tag) "EntitiesQueryResponsePageInfo" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface EntitiesQueryResponsePageInfo {
+  nextCursor?: string;
+  prevCursor?: string;
+}
+
+// Warning: (ae-missing-release-tag) "Entity" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface Entity {
+  apiVersion: string;
+  kind: string;
+  // (undocumented)
+  metadata: EntityMeta;
+  relations?: Array<EntityRelation>;
+  spec?: {
+    [key: string]: any;
+  };
+}
+
+// Warning: (ae-missing-release-tag) "EntityAncestryResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface EntityAncestryResponse {
+  // (undocumented)
+  items: Array<EntityAncestryResponseItemsInner>;
+  // (undocumented)
+  rootEntityRef: string;
+}
+
+// Warning: (ae-missing-release-tag) "EntityAncestryResponseItemsInner" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface EntityAncestryResponseItemsInner {
+  // (undocumented)
+  entity: Entity;
+  // (undocumented)
+  parentEntityRefs: Array<string>;
+}
+
+// Warning: (ae-missing-release-tag) "EntityFacet" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface EntityFacet {
+  // (undocumented)
+  count: number;
+  // (undocumented)
+  value: string;
+}
+
+// Warning: (ae-missing-release-tag) "EntityFacetsResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface EntityFacetsResponse {
+  // (undocumented)
+  facets: {
+    [key: string]: Array<EntityFacet>;
+  };
+}
+
+// Warning: (ae-missing-release-tag) "EntityLink" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface EntityLink {
+  icon?: string;
+  title?: string;
+  type?: string;
+  url: string;
+}
+
+// Warning: (ae-missing-release-tag) "EntityMeta" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface EntityMeta {
+  // (undocumented)
+  [key: string]: any;
+  annotations?: {
+    [key: string]: string;
+  };
+  description?: string;
+  etag?: string;
+  labels?: {
+    [key: string]: string;
+  };
+  links?: Array<EntityLink>;
+  name: string;
+  namespace?: string;
+  tags?: Array<string>;
+  title?: string;
+  uid?: string;
+}
+
+// Warning: (ae-missing-release-tag) "EntityRelation" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface EntityRelation {
+  targetRef: string;
+  type: string;
+}
+
+// Warning: (ae-missing-release-tag) "ErrorError" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ErrorError {
+  // (undocumented)
+  code?: string;
+  // (undocumented)
+  message: string;
+  // (undocumented)
+  name: string;
+  // (undocumented)
+  stack?: string;
+}
+
+// Warning: (ae-missing-release-tag) "ErrorRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ErrorRequest {
+  // (undocumented)
+  method: string;
+  // (undocumented)
+  url: string;
+}
+
+// Warning: (ae-missing-release-tag) "ErrorResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ErrorResponse {
+  // (undocumented)
+  statusCode: number;
+}
+
+// Warning: (ae-missing-release-tag) "GetEntitiesByRefsRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface GetEntitiesByRefsRequest {
+  // (undocumented)
+  entityRefs: Array<string>;
+  // (undocumented)
+  fields?: Array<string>;
+}
+
+// Warning: (ae-missing-release-tag) "GetLocations200ResponseInner" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface GetLocations200ResponseInner {
+  // (undocumented)
+  data: Location_2;
+}
+
+// Warning: (ae-missing-release-tag) "Location" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+interface Location_2 {
+  // (undocumented)
+  id: string;
+  // (undocumented)
+  target: string;
+  // (undocumented)
+  type: string;
+}
+export { Location_2 as Location };
+
+// Warning: (ae-missing-release-tag) "LocationInput" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface LocationInput {
+  // (undocumented)
+  target: string;
+  // (undocumented)
+  type: string;
+}
+
+// Warning: (ae-missing-release-tag) "LocationSpec" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface LocationSpec {
+  // (undocumented)
+  target: string;
+  // (undocumented)
+  type: string;
+}
+
+// Warning: (ae-missing-release-tag) "ModelError" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ModelError {
+  // (undocumented)
+  [key: string]: any;
+  // (undocumented)
+  error: ErrorError;
+  // (undocumented)
+  request?: ErrorRequest;
+  // (undocumented)
+  response: ErrorResponse;
+}
+
+// Warning: (ae-missing-release-tag) "NullableEntity" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export type NullableEntity = {
+  relations?: Array<EntityRelation>;
+  spec?: {
+    [key: string]: any;
+  };
+  metadata: EntityMeta;
+  kind: string;
+  apiVersion: string;
+} | null;
+
+// Warning: (ae-missing-release-tag) "RecursivePartialEntity" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface RecursivePartialEntity {
+  apiVersion?: string;
+  kind?: string;
+  // (undocumented)
+  metadata?: RecursivePartialEntityMeta;
+  relations?: Array<RecursivePartialEntityRelation>;
+  spec?: {
+    [key: string]: any;
+  };
+}
+
+// Warning: (ae-missing-release-tag) "RecursivePartialEntityMeta" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface RecursivePartialEntityMeta {
+  annotations?: {
+    [key: string]: string;
+  };
+  description?: string;
+  etag?: string;
+  labels?: {
+    [key: string]: string;
+  };
+  links?: Array<EntityLink>;
+  name?: string;
+  namespace?: string;
+  tags?: Array<string>;
+  title?: string;
+  uid?: string;
+}
+
+// Warning: (ae-missing-release-tag) "RecursivePartialEntityMetaAllOf" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface RecursivePartialEntityMetaAllOf {
+  annotations?: {
+    [key: string]: string;
+  };
+  description?: string;
+  etag?: string;
+  labels?: {
+    [key: string]: string;
+  };
+  links?: Array<EntityLink>;
+  name?: string;
+  namespace?: string;
+  tags?: Array<string>;
+  title?: string;
+  uid?: string;
+}
+
+// Warning: (ae-missing-release-tag) "RecursivePartialEntityRelation" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface RecursivePartialEntityRelation {
+  targetRef?: string;
+  type?: string;
+}
+
+// Warning: (ae-missing-release-tag) "RefreshEntityRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface RefreshEntityRequest {
+  // (undocumented)
+  authorizationToken?: string;
+  entityRef: string;
+}
+
+// @public
+export interface RequestOptions {
+  // (undocumented)
+  token?: string;
+}
+
+// @public
+export type TypedResponse<T> = Omit<Response, 'json'> & {
+  json: () => Promise<T>;
+};
+
+// Warning: (ae-missing-release-tag) "ValidateEntity400Response" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ValidateEntity400Response {
+  // (undocumented)
+  errors: Array<ValidateEntity400ResponseErrorsInner>;
+}
+
+// Warning: (ae-missing-release-tag) "ValidateEntity400ResponseErrorsInner" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ValidateEntity400ResponseErrorsInner {
+  // (undocumented)
+  [key: string]: any;
+  // (undocumented)
+  message: string;
+  // (undocumented)
+  name: string;
+}
+
+// Warning: (ae-missing-release-tag) "ValidateEntityRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ValidateEntityRequest {
+  // (undocumented)
+  entity: {
+    [key: string]: any;
+  };
+  // (undocumented)
+  location: string;
+}
+
+// (No @packageDocumentation comment for this package)
+```
@@ -56,6 +56,97 @@ export interface RequestOptions {
  token?: string;
 }

+export type analyzeLocationRequest = {
+  body: AnalyzeLocationRequest;
+};
+export type createLocationRequest = {
+  body: CreateLocationRequest;
+  query: {
+    dryRun?: string;
+  };
+};
+export type deleteEntityByUidRequest = {
+  path: {
+    uid: string;
+  };
+};
+export type deleteLocationRequest = {
+  path: {
+    id: string;
+  };
+};
+export type getEntitiesRequest = {
+  query: {
+    fields?: Array<string>;
+    limit?: number;
+    filter?: Array<string>;
+    offset?: number;
+    after?: string;
+    order?: Array<string>;
+  };
+};
+export type getEntitiesByQueryRequest = {
+  query: {
+    fields?: Array<string>;
+    limit?: number;
+    orderField?: Array<string>;
+    cursor?: string;
+    filter?: Array<string>;
+    fullTextFilterTerm?: string;
+    fullTextFilterFields?: Array<string>;
+  };
+};
+export type getEntitiesByRefsRequest = {
+  body: GetEntitiesByRefsRequest;
+  query: {
+    filter?: Array<string>;
+  };
+};
+export type getEntityAncestryByNameRequest = {
+  path: {
+    kind: string;
+    namespace: string;
+    name: string;
+  };
+};
+export type getEntityByNameRequest = {
+  path: {
+    kind: string;
+    namespace: string;
+    name: string;
+  };
+};
+export type getEntityByUidRequest = {
+  path: {
+    uid: string;
+  };
+};
+export type getEntityFacetsRequest = {
+  query: {
+    facet: Array<string>;
+    filter?: Array<string>;
+  };
+};
+export type getLocationRequest = {
+  path: {
+    id: string;
+  };
+};
+export type getLocationByEntityRequest = {
+  path: {
+    kind: string;
+    namespace: string;
+    name: string;
+  };
+};
+export type getLocationsRequest = {};
+export type refreshEntityRequest = {
+  body: RefreshEntityRequest;
+};
+export type validateEntityRequest = {
+  body: ValidateEntityRequest;
+};
+
 /**
 * no description
 */
@@ -77,9 +168,7 @@ export class DefaultApiClient {
   */
  public async analyzeLocation(
    // @ts-ignore
-    request: {
-      body: AnalyzeLocationRequest;
-    },
+    request: analyzeLocationRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<AnalyzeLocationResponse>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -105,12 +194,7 @@ export class DefaultApiClient {
   */
  public async createLocation(
    // @ts-ignore
-    request: {
-      body: CreateLocationRequest;
-      query: {
-        dryRun?: string;
-      };
-    },
+    request: createLocationRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<CreateLocation201Response>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -137,11 +221,7 @@ export class DefaultApiClient {
   */
  public async deleteEntityByUid(
    // @ts-ignore
-    request: {
-      path: {
-        uid: string;
-      };
-    },
+    request: deleteEntityByUidRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<void>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -167,11 +247,7 @@ export class DefaultApiClient {
   */
  public async deleteLocation(
    // @ts-ignore
-    request: {
-      path: {
-        id: string;
-      };
-    },
+    request: deleteLocationRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<void>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -202,16 +278,7 @@ export class DefaultApiClient {
   */
  public async getEntities(
    // @ts-ignore
-    request: {
-      query: {
-        fields?: Array<string>;
-        limit?: number;
-        filter?: Array<string>;
-        offset?: number;
-        after?: string;
-        order?: Array<string>;
-      };
-    },
+    request: getEntitiesRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<Array<Entity>>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -243,18 +310,7 @@ export class DefaultApiClient {
   */
  public async getEntitiesByQuery(
    // @ts-ignore
-    request: {
-      query: {
-        fields?: Array<string>;
-        limit?: number;
-        offset?: number;
-        orderField?: Array<string>;
-        cursor?: string;
-        filter?: Array<string>;
-        fullTextFilterTerm?: string;
-        fullTextFilterFields?: Array<string>;
-      };
-    },
+    request: getEntitiesByQueryRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<EntitiesQueryResponse>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -281,12 +337,7 @@ export class DefaultApiClient {
   */
  public async getEntitiesByRefs(
    // @ts-ignore
-    request: {
-      body: GetEntitiesByRefsRequest;
-      query: {
-        filter?: Array<string>;
-      };
-    },
+    request: getEntitiesByRefsRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<EntitiesBatchResponse>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -315,13 +366,7 @@ export class DefaultApiClient {
   */
  public async getEntityAncestryByName(
    // @ts-ignore
-    request: {
-      path: {
-        kind: string;
-        namespace: string;
-        name: string;
-      };
-    },
+    request: getEntityAncestryByNameRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<EntityAncestryResponse>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -351,13 +396,7 @@ export class DefaultApiClient {
   */
  public async getEntityByName(
    // @ts-ignore
-    request: {
-      path: {
-        kind: string;
-        namespace: string;
-        name: string;
-      };
-    },
+    request: getEntityByNameRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<Entity>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -385,11 +424,7 @@ export class DefaultApiClient {
   */
  public async getEntityByUid(
    // @ts-ignore
-    request: {
-      path: {
-        uid: string;
-      };
-    },
+    request: getEntityByUidRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<Entity>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -416,12 +451,7 @@ export class DefaultApiClient {
   */
  public async getEntityFacets(
    // @ts-ignore
-    request: {
-      query: {
-        facet: Array<string>;
-        filter?: Array<string>;
-      };
-    },
+    request: getEntityFacetsRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<EntityFacetsResponse>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -447,11 +477,7 @@ export class DefaultApiClient {
   */
  public async getLocation(
    // @ts-ignore
-    request: {
-      path: {
-        id: string;
-      };
-    },
+    request: getLocationRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<Location>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -479,13 +505,7 @@ export class DefaultApiClient {
   */
  public async getLocationByEntity(
    // @ts-ignore
-    request: {
-      path: {
-        kind: string;
-        namespace: string;
-        name: string;
-      };
-    },
+    request: getLocationByEntityRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<Location>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -512,7 +532,7 @@ export class DefaultApiClient {
   */
  public async getLocations(
    // @ts-ignore
-    request: {},
+    request: getLocationsRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<Array<GetLocations200ResponseInner>>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -536,9 +556,7 @@ export class DefaultApiClient {
   */
  public async refreshEntity(
    // @ts-ignore
-    request: {
-      body: RefreshEntityRequest;
-    },
+    request: refreshEntityRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<void>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -563,9 +581,7 @@ export class DefaultApiClient {
   */
  public async validateEntity(
    // @ts-ignore
-    request: {
-      body: ValidateEntityRequest;
-    },
+    request: validateEntityRequest,
    options?: RequestOptions,
  ): Promise<TypedResponse<void>> {
    const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -18,6 +18,9 @@
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************

+/**
+ * @public
+ */
 export interface AnalyzeLocationEntityField {
  /**
   * A text to show to the user to inform about the choices made. Like, it could say \"Found a CODEOWNERS file that covers this target, so we suggest leaving this field empty; which would currently make it owned by X\" where X is taken from the codeowners file.
@@ -34,6 +37,9 @@ export interface AnalyzeLocationEntityField {
  field: string;
 }

+/**
+ * @public
+ */
 export type AnalyzeLocationEntityFieldStateEnum =
  | 'analysisSuggestedValue'
  | 'analysisSuggestedNoValue'
@@ -22,6 +22,7 @@ import { LocationSpec } from '../models/LocationSpec.model';

 /**
 * If the folder pointed to already contained catalog info yaml files, they are read and emitted like this so that the frontend can inform the user that it located them and can make sure to register them as well if they weren't already
+ * @public
 */
 export interface AnalyzeLocationExistingEntity {
  entity: Entity;
@@ -22,6 +22,7 @@ import { RecursivePartialEntity } from '../models/RecursivePartialEntity.model';

 /**
 * This is some form of representation of what the analyzer could deduce. We should probably have a chat about how this can best be conveyed to the frontend. It'll probably contain a (possibly incomplete) entity, plus enough info for the frontend to know what form data to show to the user for overriding/completing the info.
+ * @public
 */
 export interface AnalyzeLocationGenerateEntity {
  fields: Array<AnalyzeLocationEntityField>;
@@ -19,6 +19,9 @@
 // ******************************************************************
 import { LocationInput } from '../models/LocationInput.model';

+/**
+ * @public
+ */
 export interface AnalyzeLocationRequest {
  catalogFileName?: string;
  location: LocationInput;
@@ -20,6 +20,9 @@
 import { AnalyzeLocationExistingEntity } from '../models/AnalyzeLocationExistingEntity.model';
 import { AnalyzeLocationGenerateEntity } from '../models/AnalyzeLocationGenerateEntity.model';

+/**
+ * @public
+ */
 export interface AnalyzeLocationResponse {
  generateEntities: Array<AnalyzeLocationGenerateEntity>;
  existingEntityFiles: Array<AnalyzeLocationExistingEntity>;
@@ -20,6 +20,9 @@
 import { Entity } from '../models/Entity.model';
 import { Location } from '../models/Location.model';

+/**
+ * @public
+ */
 export interface CreateLocation201Response {
  exists?: boolean;
  entities: Array<Entity>;
@@ -18,6 +18,9 @@
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************

+/**
+ * @public
+ */
 export interface CreateLocationRequest {
  target: string;
  type: string;
@@ -19,6 +19,9 @@
 // ******************************************************************
 import { NullableEntity } from '../models/NullableEntity.model';

+/**
+ * @public
+ */
 export interface EntitiesBatchResponse {
  /**
   * The list of entities, in the same order as the refs in the request. Entries that are null signify that no entity existed with that ref.
@@ -20,6 +20,9 @@
 import { EntitiesQueryResponsePageInfo } from '../models/EntitiesQueryResponsePageInfo.model';
 import { Entity } from '../models/Entity.model';

+/**
+ * @public
+ */
 export interface EntitiesQueryResponse {
  /**
   * The list of entities paginated by a specific filter.
@@ -18,6 +18,9 @@
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************

+/**
+ * @public
+ */
 export interface EntitiesQueryResponsePageInfo {
  /**
   * The cursor for the next batch of entities.
@@ -22,6 +22,7 @@ import { EntityRelation } from '../models/EntityRelation.model';

 /**
 * The parts of the format that's common to all versions/kinds of entity.
+ * @public
 */
 export interface Entity {
  /**
@@ -19,6 +19,9 @@
 // ******************************************************************
 import { EntityAncestryResponseItemsInner } from '../models/EntityAncestryResponseItemsInner.model';

+/**
+ * @public
+ */
 export interface EntityAncestryResponse {
  items: Array<EntityAncestryResponseItemsInner>;
  rootEntityRef: string;
@@ -19,6 +19,9 @@
 // ******************************************************************
 import { Entity } from '../models/Entity.model';

+/**
+ * @public
+ */
 export interface EntityAncestryResponseItemsInner {
  parentEntityRefs: Array<string>;
  entity: Entity;
@@ -18,6 +18,9 @@
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************

+/**
+ * @public
+ */
 export interface EntityFacet {
  value: string;
  count: number;
@@ -19,6 +19,9 @@
 // ******************************************************************
 import { EntityFacet } from '../models/EntityFacet.model';

+/**
+ * @public
+ */
 export interface EntityFacetsResponse {
  facets: { [key: string]: Array<EntityFacet> };
 }
@@ -20,6 +20,7 @@

 /**
 * A link to external information that is related to the entity.
+ * @public
 */
 export interface EntityLink {
  /**
@@ -21,6 +21,7 @@ import { EntityLink } from '../models/EntityLink.model';

 /**
 * Metadata fields common to all versions/kinds of entity.
+ * @public
 */
 export interface EntityMeta {
  [key: string]: any;
@@ -20,6 +20,7 @@

 /**
 * A relation of a specific type to another entity in the catalog.
+ * @public
 */
 export interface EntityRelation {
  /**
@@ -18,6 +18,9 @@
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************

+/**
+ * @public
+ */
 export interface ErrorError {
  name: string;
  message: string;
@@ -18,6 +18,9 @@
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************

+/**
+ * @public
+ */
 export interface ErrorRequest {
  method: string;
  url: string;
@@ -18,6 +18,9 @@
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************

+/**
+ * @public
+ */
 export interface ErrorResponse {
  statusCode: number;
 }
@@ -18,6 +18,9 @@
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************

+/**
+ * @public
+ */
 export interface GetEntitiesByRefsRequest {
  entityRefs: Array<string>;
  fields?: Array<string>;
@@ -19,6 +19,9 @@
 // ******************************************************************
 import { Location } from '../models/Location.model';

+/**
+ * @public
+ */
 export interface GetLocations200ResponseInner {
  data: Location;
 }
@@ -20,6 +20,7 @@

 /**
 * Entity location for a specific entity.
+ * @public
 */
 export interface Location {
  target: string;
@@ -18,6 +18,9 @@
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************

+/**
+ * @public
+ */
 export interface LocationInput {
  type: string;
  target: string;
@@ -20,6 +20,7 @@

 /**
 * Holds the entity location information.
+ * @public
 */
 export interface LocationSpec {
  target: string;
@@ -21,6 +21,9 @@ import { ErrorError } from '../models/ErrorError.model';
 import { ErrorRequest } from '../models/ErrorRequest.model';
 import { ErrorResponse } from '../models/ErrorResponse.model';

+/**
+ * @public
+ */
 export interface ModelError {
  [key: string]: any;

@@ -22,6 +22,7 @@ import { EntityRelation } from '../models/EntityRelation.model';

 /**
 * The parts of the format that's common to all versions/kinds of entity.
+ * @public
 */
 export type NullableEntity = {
  /**
@@ -22,6 +22,7 @@ import { RecursivePartialEntityRelation } from '../models/RecursivePartialEntity

 /**
 * Makes all keys of an entire hierarchy optional.
+ * @public
 */
 export interface RecursivePartialEntity {
  /**
@@ -19,6 +19,9 @@
 // ******************************************************************
 import { EntityLink } from '../models/EntityLink.model';

+/**
+ * @public
+ */
 export interface RecursivePartialEntityMeta {
  /**
   * A list of external hyperlinks related to the entity.
@@ -21,6 +21,7 @@ import { EntityLink } from '../models/EntityLink.model';

 /**
 * Metadata fields common to all versions/kinds of entity.
+ * @public
 */
 export interface RecursivePartialEntityMetaAllOf {
  /**
@@ -20,6 +20,7 @@

 /**
 * A relation of a specific type to another entity in the catalog.
+ * @public
 */
 export interface RecursivePartialEntityRelation {
  /**
@@ -20,6 +20,7 @@

 /**
 * Options for requesting a refresh of entities in the catalog.
+ * @public
 */
 export interface RefreshEntityRequest {
  authorizationToken?: string;
@@ -19,6 +19,9 @@
 // ******************************************************************
 import { ValidateEntity400ResponseErrorsInner } from '../models/ValidateEntity400ResponseErrorsInner.model';

+/**
+ * @public
+ */
 export interface ValidateEntity400Response {
  errors: Array<ValidateEntity400ResponseErrorsInner>;
 }
@@ -18,6 +18,9 @@
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************

+/**
+ * @public
+ */
 export interface ValidateEntity400ResponseErrorsInner {
  [key: string]: any;

@@ -18,6 +18,9 @@
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************

+/**
+ * @public
+ */
 export interface ValidateEntityRequest {
  location: string;
  entity: { [key: string]: any };
@@ -29,6 +29,37 @@ export interface RequestOptions {
  token?: string;
 }

+{{#operation}}
+export type {{nickname}}Request = {
+    {{#hasPathParams}}
+    path: {
+        {{#pathParams}}
+            {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
+        {{/pathParams}}
+    },
+    {{/hasPathParams}}
+    {{#hasBodyParam}}
+        {{#bodyParam}}
+        body: {{{dataType}}},
+        {{/bodyParam}}
+    {{/hasBodyParam}}
+    {{#hasQueryParams}}
+    query: {
+        {{#queryParams}}
+        {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
+        {{/queryParams}}
+    },
+    {{/hasQueryParams}}
+    {{#hasHeaderParams}}
+    header: {
+        {{#headerParams}}
+        {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
+        {{/headerParams}}
+    },
+    {{/hasHeaderParams}}
+}
+{{/operation}}
+
 /**
 * {{{description}}}{{^description}}no description{{/description}}
 */
@@ -58,34 +89,7 @@ export class {{classname}}Client {
     */
    public async {{nickname}}(
        // @ts-ignore
-        request: {
-            {{#hasPathParams}}
-            path: {
-                {{#pathParams}}
-                    {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
-                {{/pathParams}}
-            },
-            {{/hasPathParams}}
-            {{#hasBodyParam}}
-                {{#bodyParam}}
-                body: {{{dataType}}},
-                {{/bodyParam}}
-            {{/hasBodyParam}}
-            {{#hasQueryParams}}
-            query: {
-                {{#queryParams}}
-                {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
-                {{/queryParams}}
-            },
-            {{/hasQueryParams}}
-            {{#hasHeaderParams}}
-            header: {
-                {{#headerParams}}
-                {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
-                {{/headerParams}}
-            },
-            {{/hasHeaderParams}}
-        },
+        request: {{nickname}}Request,
        options?: RequestOptions
    ): Promise<TypedResponse<{{{returnType}}} {{^returnType}}void{{/returnType}}>> {
        const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
@@ -1,3 +1,6 @@
 {{! Sourced from https://github.com/OpenAPITools/openapi-generator/blob/7347daec61b2cb8d3d28e1ed06fe8b5e682090f8/modules/openapi-generator/src/main/resources/typescript-angular/modelAlias.mustache }}

+/**
+  * @public
+  */
 export type {{classname}} = {{dataType}};
@@ -1,6 +1,9 @@
 {{! Sourced from https://github.com/OpenAPITools/openapi-generator/blob/7347daec61b2cb8d3d28e1ed06fe8b5e682090f8/modules/openapi-generator/src/main/resources/typescript-angular/modelEnum.mustache }}

 {{#stringEnums}}
+/**
+  * @public
+  */
 export enum {{classname}} {
 {{#allowableValues}}
 {{#enumVars}}
@@ -10,8 +13,14 @@ export enum {{classname}} {
 }
 {{/stringEnums}}
 {{^stringEnums}}
+/**
+  * @public
+  */
 export type {{classname}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}} | {{/-last}}{{/enumVars}}{{/allowableValues}};

+/**
+  * @public
+  */
 export const {{classname}} = {
 {{#allowableValues}}
 {{#enumVars}}
@@ -3,11 +3,12 @@
 {{#models}}
 {{#model}}

-{{#description}}
 /**
+{{#description}}
 * {{{.}}}
-*/
 {{/description}}
+* @public
+*/
 {{^isEnum}}
 export {{#isNullable}}type{{/isNullable}}{{^isNullable}}interface{{/isNullable}} {{classname}} {{#isNullable}}={{/isNullable}} {
 {{>modelGenericAdditionalProperties}}
@@ -25,6 +26,9 @@ export {{#isNullable}}type{{/isNullable}}{{^isNullable}}interface{{/isNullable}}

 {{#vars}}
 {{#isEnum}}
+/**
+  * @public
+  */
 export type {{classname}}{{enumName}} ={{#allowableValues}}{{#values}} "{{.}}" {{^-last}}|{{/-last}}{{/values}}{{/allowableValues}};
 {{/isEnum}}
 {{/vars}}
@@ -32,6 +36,9 @@ export type {{classname}}{{enumName}} ={{#allowableValues}}{{#values}} "{{.}}" {
 {{/hasEnums}}
 {{/isEnum}}
 {{#isEnum}}
+/**
+  * @public
+  */
 export type {{classname}} ={{#allowableValues}}{{#values}} "{{.}}" {{^-last}}|{{/-last}}{{/values}}{{/allowableValues}};
 {{/isEnum}}
 {{/model}}
@@ -3,11 +3,17 @@
 {{#hasEnums}}

 {{^stringEnums}}
+/**
+  * @public
+  */
 export namespace {{classname}} {
 {{/stringEnums}}
 {{#vars}}
    {{#isEnum}}
 {{#stringEnums}}
+/**
+  * @public
+  */
 export enum {{classname}}{{enumName}} {
 {{#allowableValues}}
 {{#enumVars}}
@@ -17,7 +23,14 @@ export enum {{classname}}{{enumName}} {
 };
 {{/stringEnums}}
 {{^stringEnums}}
+    /**
+    * @public
+    */
    export type {{enumName}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}} | {{/-last}}{{/enumVars}}{{/allowableValues}};
+
+    /**
+    * @public
+    */
    export const {{enumName}} = {
    {{#allowableValues}}
    {{#enumVars}}
@@ -8,9 +8,10 @@ import {
 } from './';

 {{/hasImports}}
-{{#description}}
    /**
+{{#description}}
    * {{{.}}}
-    */
 {{/description}}
+    * @public
+    */
 export type {{classname}} = {{#oneOf}}{{{.}}}{{^-last}} | {{/-last}}{{/oneOf}};
@@ -53,7 +53,7 @@
    "clean": "backstage-cli package clean",
    "diff": "backstage-repo-tools package schema openapi diff",
    "fuzz": "backstage-repo-tools package schema openapi fuzz --exclude-checks response_schema_conformance",
-    "generate": "backstage-repo-tools package schema openapi generate --server --client-package packages/catalog-client",
+    "generate": "backstage-repo-tools package schema openapi generate --server --client-package packages/catalog-client --server-client-import \"@backstage/catalog-client/alpha\"",
    "lint": "backstage-cli package lint",
    "prepack": "backstage-cli package prepack",
    "postpack": "backstage-cli package postpack",