/** * Contains information about an ADR file. * * @public */ export type AdrFileInfo = { /** The file type. */ type: string; /** The relative path of the ADR file. */ path: string; /** The name of the ADR file. */ name: string; /** The title of the ADR. */ title?: string; /** The status of the ADR. */ status?: string; /** The date of the ADR. */ date?: string; }; /** * The result of listing ADRs. * * @public */ export type AdrListResult = { data: AdrFileInfo[]; }; /** * The result of reading an ADR. * * @public */ export type AdrReadResult = { /** The contents of the read ADR file. */ data: string; }; /** * The API used by the adr plugin to list and read ADRs. * * @public */ export interface AdrApi { /** Lists the ADRs at the provided url. */ listAdrs(url: string): Promise; /** Reads the contents of the ADR at the provided url. */ readAdr(url: string): Promise; } /** * ApiRef for the AdrApi. * * @public */ export declare const adrApiRef: import("@backstage/core-plugin-api").ApiRef;