fix changesets and api reports

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
This commit is contained in:
aramissennyeydd
2024-04-09 11:17:02 -04:00
parent 973eaa2672
commit e8909488a3
7 changed files with 210 additions and 18 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-todo-common': minor
---
Creates a new common package to host the generated client at `@backstage/plugin-todo-common/client`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-search-common': minor
---
Adds a new export for the generated client, `@backstage/plugin-search-common/client`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-todo': minor
---
Updates the `TodoClient` to use `fetchApi` instead of `identityApi` for authenticated calls.
+107
View File
@@ -0,0 +1,107 @@
## API Report File for "@backstage/plugin-search-common"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
// @public
export class DefaultApiClient {
constructor(options: {
discoveryApi: {
getBaseUrl(pluginId: string): Promise<string>;
};
fetchApi?: {
fetch: typeof fetch;
};
});
query(
request: Query,
options?: RequestOptions,
): Promise<TypedResponse<Query200Response>>;
}
// @public (undocumented)
export interface ErrorError {
// (undocumented)
message: string;
// (undocumented)
name: string;
}
// @public (undocumented)
export interface ErrorRequest {
// (undocumented)
method: string;
// (undocumented)
url: string;
}
// @public (undocumented)
export interface ErrorResponse {
// (undocumented)
statusCode: number;
}
// @public (undocumented)
export interface ModelError {
// (undocumented)
error: ErrorError;
// (undocumented)
request: ErrorRequest;
// (undocumented)
response: ErrorResponse;
}
// @public (undocumented)
export type Query = {
query: {
term?: string;
filters?: {
[key: string]: any;
};
types?: Array<string>;
pageCursor?: string;
pageLimit?: number;
};
};
// @public (undocumented)
export interface Query200Response {
// (undocumented)
nextPageCursor?: string;
// (undocumented)
numberOfResults?: number;
// (undocumented)
previousPageCursor?: string;
// (undocumented)
results: Array<Query200ResponseResultsInner>;
}
// @public (undocumented)
export interface Query200ResponseResultsInner {
// (undocumented)
document: Query200ResponseResultsInnerDocument;
highlight?: any;
rank?: number;
type: string;
}
// @public
export interface Query200ResponseResultsInnerDocument {
location?: string;
text?: string;
title?: string;
}
// @public
export interface RequestOptions {
// (undocumented)
token?: string;
}
// @public
export type TypedResponse<T> = Omit<Response, 'json'> & {
json: () => Promise<T>;
};
// (No @packageDocumentation comment for this package)
```
+80
View File
@@ -0,0 +1,80 @@
## API Report File for "@backstage/plugin-todo-common"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
// @public
export class DefaultApiClient {
constructor(options: {
discoveryApi: {
getBaseUrl(pluginId: string): Promise<string>;
};
fetchApi?: {
fetch: typeof fetch;
};
});
// (undocumented)
listTodos(
request: ListTodos,
options?: RequestOptions,
): Promise<TypedResponse<ListTodos200Response>>;
}
// @public (undocumented)
export type ListTodos = {
query: {
entity?: string;
orderBy?: string;
filter?: Array<string>;
offset?: number;
limit?: number;
};
};
// @public (undocumented)
export interface ListTodos200Response {
// (undocumented)
items: Array<TodoItem>;
// (undocumented)
limit: number;
// (undocumented)
offset: number;
// (undocumented)
totalCount: number;
}
// @public (undocumented)
export interface ListTodos400Response {
// (undocumented)
error?: ListTodos400ResponseError;
}
// @public (undocumented)
export interface ListTodos400ResponseError {
// (undocumented)
message?: string;
}
// @public
export interface RequestOptions {
// (undocumented)
token?: string;
}
// @public (undocumented)
export interface TodoItem {
author?: string;
lineNumber?: number;
repoFilePath?: string;
tag: string;
text: string;
viewUrl?: string;
}
// @public
export type TypedResponse<T> = Omit<Response, 'json'> & {
json: () => Promise<T>;
};
// (No @packageDocumentation comment for this package)
```
+7
View File
@@ -0,0 +1,7 @@
## API Report File for "@backstage/plugin-todo-common"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
// (No @packageDocumentation comment for this package)
```
+1 -18
View File
@@ -14,21 +14,4 @@
* limitations under the License.
*/
/**
* Common functionalities for the todo plugin.
*
* @packageDocumentation
*/
/**
* In this package you might for example declare types that are common
* between the frontend and backend plugin packages.
*/
export type CommonType = {
field: string;
};
/**
* Or you might declare some common constants.
*/
export const COMMON_CONSTANT = 1;
export {};