Update URLs to be more consistent

GET  /report?entity=<ref>

POST /report?entity=<ref>&coverageType=<cobertura|jacoco>

GET  /history?entity=<ref>

GET  /file-content?entity=<ref>&path=<filepath>

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
alde
2021-04-19 11:36:19 -04:00
committed by Fredrik Adelöw
parent e7d2fb93f0
commit 0e57ec3f91
7 changed files with 105 additions and 101 deletions
+12 -14
View File
@@ -16,7 +16,7 @@
import { createApiRef } from '@backstage/core';
import { Config } from '@backstage/config';
import { EntityName } from '@backstage/catalog-model';
import { EntityName, stringifyEntityRef } from '@backstage/catalog-model';
export class FetchError extends Error {
get name(): string {
@@ -69,33 +69,31 @@ export class CodeCoverageRestApi implements CodeCoverageApi {
return await resp.text();
}
async getCoverageForEntity({
kind,
namespace,
name,
}: EntityName): Promise<any> {
return await this.fetch<any>(
`/api/code-coverage/${kind}/${namespace}/${name}`,
);
async getCoverageForEntity(entityName: EntityName): Promise<any> {
const entity = stringifyEntityRef(entityName);
return await this.fetch<any>(`/api/code-coverage/report?entity=${entity}`);
}
async getFileContentFromEntity(
{ kind, namespace, name }: EntityName,
entityName: EntityName,
filePath: string,
): Promise<any> {
const entity = stringifyEntityRef(entityName);
return await this.fetch<any>(
`/api/code-coverage/${kind}/${namespace}/${name}/file-content?path=${filePath}`,
/// file-content?entity=component:default/mycomponent&path=src/some-file.go
`/api/code-coverage/file-content?entity=${entity}&path=${filePath}`,
);
}
async getCoverageHistoryForEntity(
{ kind, namespace, name }: EntityName,
entityName: EntityName,
limit?: number,
): Promise<any> {
const entity = stringifyEntityRef(entityName);
const hasValidLimit = limit && limit > 0;
return await this.fetch<any>(
`/api/code-coverage/${kind}/${namespace}/${name}/history${
hasValidLimit ? `?limit=${limit}` : ''
`/api/code-coverage/history?entity=${entity}${
hasValidLimit ? `&limit=${limit}` : ''
}`,
);
}