Reference

BackstageClient.meta

BackstageClient.meta in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / meta

meta: {
  versions: (requestOptions?: RequestOptions) => Promise<{
     current: string;
     resolved: string;
     versions: {
        breakingChanges: string[];
        date: string;
        deprecatedAt: string | null;
        status: "current" | "supported" | "deprecated" | "sunset";
        summary: string;
        sunsetAt: string | null;
     }[];
  }>;
};

Defined in: client.ts:1633

Meta methods

versions()#

versions: (requestOptions?: RequestOptions) => Promise<{
  current: string;
  resolved: string;
  versions: {
     breakingChanges: string[];
     date: string;
     deprecatedAt: string | null;
     status: "current" | "supported" | "deprecated" | "sunset";
     summary: string;
     sunsetAt: string | null;
  }[];
}>;

List API versions Lists all dated API versions with their lifecycle status. Pin a version per-request with the TL-Version header; organisations are pinned to the version current at signup by default.

Parameters#

Parameter	Type
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ current: string; resolved: string; versions: { breakingChanges: string[]; date: string; deprecatedAt: string | null; status: "current" | "supported" | "deprecated" | "sunset"; summary: string; sunsetAt: string | null; }[]; }>

Operation Id#

listApiVersions