Skip to main content
Version: Next

CatalogClient.validateEntity()

Home > @backstage/catalog-client > CatalogClient > validateEntity

Validate entity and its location.

Signature:

validateEntity(entity: Entity, locationRef: string, options?: CatalogRequestOptions): Promise<ValidateEntityResponse>;

Parameters

ParameterTypeDescription
entityEntityEntity to validate
locationRefstringLocation ref in format
url:http://example.com/file
optionsCatalogRequestOptions(Optional)

Returns:

Promise<ValidateEntityResponse>