Skip to main content

CatalogClient.validateEntity()

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

Validate entity and its location.

Signature:

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

Parameters

Parameter

Type

Description

entity

Entity

Entity to validate

locationRef

string

Location ref in format url:http://example.com/file

options

CatalogRequestOptions

(Optional) Additional options

**Returns:**

Promise<ValidateEntityResponse>