diff --git a/packages/catalog-model/src/EntityPolicies.ts b/packages/catalog-model/src/EntityPolicies.ts index 1e71688c33..cf23bcdc88 100644 --- a/packages/catalog-model/src/EntityPolicies.ts +++ b/packages/catalog-model/src/EntityPolicies.ts @@ -15,14 +15,17 @@ */ import { + DefaultNamespaceEntityPolicy, Entity, FieldFormatEntityPolicy, NoForeignRootFieldsEntityPolicy, ReservedFieldsEntityPolicy, SchemaValidEntityPolicy, } from './entity'; -import { DefaultNamespaceEntityPolicy } from './entity/policies/DefaultNamespaceEntityPolicy'; -import { ComponentV1beta1Policy, LocationRefV1beta1Policy } from './kinds'; +import { + ComponentEntityV1beta1Policy, + LocationEntityV1beta1Policy, +} from './kinds'; import { EntityPolicy } from './types'; // Helper that requires that all of a set of policies can be successfully @@ -69,8 +72,8 @@ export class EntityPolicies implements EntityPolicy { new ReservedFieldsEntityPolicy(), ]), EntityPolicies.anyOf([ - new ComponentV1beta1Policy(), - new LocationRefV1beta1Policy(), + new ComponentEntityV1beta1Policy(), + new LocationEntityV1beta1Policy(), ]), ]); } diff --git a/packages/catalog-model/src/entity/policies/index.ts b/packages/catalog-model/src/entity/policies/index.ts index d64053f7cb..eb7c0e8378 100644 --- a/packages/catalog-model/src/entity/policies/index.ts +++ b/packages/catalog-model/src/entity/policies/index.ts @@ -14,6 +14,7 @@ * limitations under the License. */ +export { DefaultNamespaceEntityPolicy } from './DefaultNamespaceEntityPolicy'; export { FieldFormatEntityPolicy } from './FieldFormatEntityPolicy'; export { NoForeignRootFieldsEntityPolicy } from './NoForeignRootFieldsEntityPolicy'; export { ReservedFieldsEntityPolicy } from './ReservedFieldsEntityPolicy'; diff --git a/packages/catalog-model/src/kinds/ComponentV1beta1.ts b/packages/catalog-model/src/kinds/ComponentEntityV1beta1.ts similarity index 87% rename from packages/catalog-model/src/kinds/ComponentV1beta1.ts rename to packages/catalog-model/src/kinds/ComponentEntityV1beta1.ts index 32e315bb06..2f5e8e079c 100644 --- a/packages/catalog-model/src/kinds/ComponentV1beta1.ts +++ b/packages/catalog-model/src/kinds/ComponentEntityV1beta1.ts @@ -21,7 +21,7 @@ import type { EntityPolicy } from '../types'; const API_VERSION = 'backstage.io/v1beta1'; const KIND = 'Component'; -export interface ComponentV1beta1 extends Entity { +export interface ComponentEntityV1beta1 extends Entity { apiVersion: typeof API_VERSION; kind: typeof KIND; spec: { @@ -29,11 +29,11 @@ export interface ComponentV1beta1 extends Entity { }; } -export class ComponentV1beta1Policy implements EntityPolicy { +export class ComponentEntityV1beta1Policy implements EntityPolicy { private schema: yup.Schema; constructor() { - this.schema = yup.object>({ + this.schema = yup.object>({ spec: yup .object({ type: yup.string().required(), diff --git a/packages/catalog-model/src/kinds/LocationRefV1beta1.ts b/packages/catalog-model/src/kinds/LocationEntityV1beta1.ts similarity index 87% rename from packages/catalog-model/src/kinds/LocationRefV1beta1.ts rename to packages/catalog-model/src/kinds/LocationEntityV1beta1.ts index 74b68fe097..e68bb00aa0 100644 --- a/packages/catalog-model/src/kinds/LocationRefV1beta1.ts +++ b/packages/catalog-model/src/kinds/LocationEntityV1beta1.ts @@ -19,9 +19,9 @@ import type { Entity } from '../entity/Entity'; import type { EntityPolicy } from '../types'; const API_VERSION = 'backstage.io/v1beta1'; -const KIND = 'LocationRef'; +const KIND = 'Location'; -export interface LocationRefV1beta1 extends Entity { +export interface LocationEntityV1beta1 extends Entity { apiVersion: typeof API_VERSION; kind: typeof KIND; spec: { @@ -31,11 +31,11 @@ export interface LocationRefV1beta1 extends Entity { }; } -export class LocationRefV1beta1Policy implements EntityPolicy { +export class LocationEntityV1beta1Policy implements EntityPolicy { private schema: yup.Schema; constructor() { - this.schema = yup.object>({ + this.schema = yup.object>({ spec: yup .object({ type: yup.string().required(), diff --git a/packages/catalog-model/src/kinds/index.ts b/packages/catalog-model/src/kinds/index.ts index 8159b3b214..2d2a0744c5 100644 --- a/packages/catalog-model/src/kinds/index.ts +++ b/packages/catalog-model/src/kinds/index.ts @@ -14,13 +14,13 @@ * limitations under the License. */ -export { ComponentV1beta1Policy } from './ComponentV1beta1'; +export { ComponentEntityV1beta1Policy } from './ComponentEntityV1beta1'; export type { - ComponentV1beta1 as Component, - ComponentV1beta1, -} from './ComponentV1beta1'; -export { LocationRefV1beta1Policy } from './LocationRefV1beta1'; + ComponentEntityV1beta1 as ComponentEntity, + ComponentEntityV1beta1, +} from './ComponentEntityV1beta1'; +export { LocationEntityV1beta1Policy } from './LocationEntityV1beta1'; export type { - LocationRefV1beta1 as LocationRef, - LocationRefV1beta1, -} from './LocationRefV1beta1'; + LocationEntityV1beta1 as LocationEntity, + LocationEntityV1beta1, +} from './LocationEntityV1beta1'; diff --git a/plugins/catalog-backend/examples/locationref.yaml b/plugins/catalog-backend/examples/example-location.yaml similarity index 91% rename from plugins/catalog-backend/examples/locationref.yaml rename to plugins/catalog-backend/examples/example-location.yaml index 78297f4fcd..5c507b29b5 100644 --- a/plugins/catalog-backend/examples/locationref.yaml +++ b/plugins/catalog-backend/examples/example-location.yaml @@ -1,6 +1,6 @@ --- apiVersion: backstage.io/v1beta1 -kind: LocationRef +kind: Location metadata: name: location-1 spec: diff --git a/plugins/catalog-backend/src/ingestion/LocationReaders.ts b/plugins/catalog-backend/src/ingestion/LocationReaders.ts index 270d859753..eee16ea0de 100644 --- a/plugins/catalog-backend/src/ingestion/LocationReaders.ts +++ b/plugins/catalog-backend/src/ingestion/LocationReaders.ts @@ -26,7 +26,7 @@ import { AnnotateLocationEntityProcessor } from './processors/AnnotateLocationEn import { EntityPolicyProcessor } from './processors/EntityPolicyProcessor'; import { FileReaderProcessor } from './processors/FileReaderProcessor'; import { GithubReaderProcessor } from './processors/GithubReaderProcessor'; -import { LocationRefProcessor } from './processors/LocationRefProcessor'; +import { LocationRefProcessor } from './processors/LocationEntityProcessor'; import * as result from './processors/results'; import { LocationProcessor, diff --git a/plugins/catalog-backend/src/ingestion/processors/LocationRefProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.ts similarity index 88% rename from plugins/catalog-backend/src/ingestion/processors/LocationRefProcessor.ts rename to plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.ts index 03cdd9229f..a5c9718574 100644 --- a/plugins/catalog-backend/src/ingestion/processors/LocationRefProcessor.ts +++ b/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { Entity, LocationRef, LocationSpec } from '@backstage/catalog-model'; +import { Entity, LocationEntity, LocationSpec } from '@backstage/catalog-model'; import * as result from './results'; import { LocationProcessor, LocationProcessorEmit } from './types'; @@ -24,8 +24,8 @@ export class LocationRefProcessor implements LocationProcessor { _location: LocationSpec, emit: LocationProcessorEmit, ): Promise { - if (entity.kind === 'LocationRef') { - const location = entity as LocationRef; + if (entity.kind === 'Location') { + const location = entity as LocationEntity; if (location.spec.target) { emit( result.location(