Merge pull request #10013 from backstage/freben/no-name
remove `CatalogApi.getEntityByName`
This commit is contained in:
@@ -38,11 +38,6 @@ export interface CatalogApi {
|
||||
request: GetEntityAncestorsRequest,
|
||||
options?: CatalogRequestOptions,
|
||||
): Promise<GetEntityAncestorsResponse>;
|
||||
// @deprecated
|
||||
getEntityByName(
|
||||
name: CompoundEntityRef,
|
||||
options?: CatalogRequestOptions,
|
||||
): Promise<Entity | undefined>;
|
||||
getEntityByRef(
|
||||
entityRef: string | CompoundEntityRef,
|
||||
options?: CatalogRequestOptions,
|
||||
@@ -95,6 +90,7 @@ export class CatalogClient implements CatalogApi {
|
||||
request: GetEntityAncestorsRequest,
|
||||
options?: CatalogRequestOptions,
|
||||
): Promise<GetEntityAncestorsResponse>;
|
||||
// @deprecated (undocumented)
|
||||
getEntityByName(
|
||||
compoundName: CompoundEntityRef,
|
||||
options?: CatalogRequestOptions,
|
||||
|
||||
@@ -190,7 +190,7 @@ export class CatalogClient implements CatalogApi {
|
||||
// longer, to minimize the risk for breakages. Suggested date for removal:
|
||||
// August 2022
|
||||
/**
|
||||
* {@inheritdoc CatalogApi.getEntityByName}
|
||||
* @deprecated Use getEntityByRef instead
|
||||
*/
|
||||
async getEntityByName(
|
||||
compoundName: CompoundEntityRef,
|
||||
|
||||
@@ -315,19 +315,6 @@ export interface CatalogApi {
|
||||
options?: CatalogRequestOptions,
|
||||
): Promise<Entity | undefined>;
|
||||
|
||||
/**
|
||||
* Gets a single entity from the catalog by its ref (kind, namespace, name)
|
||||
* triplet.
|
||||
*
|
||||
* @deprecated Use getEntityRef instead
|
||||
* @param name - A complete entity ref
|
||||
* @param options - Additional options
|
||||
*/
|
||||
getEntityByName(
|
||||
name: CompoundEntityRef,
|
||||
options?: CatalogRequestOptions,
|
||||
): Promise<Entity | undefined>;
|
||||
|
||||
/**
|
||||
* Removes a single entity from the catalog by entity UID.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user