diff --git a/plugins/azure-sites-backend/README.md b/plugins/azure-sites-backend/README.md
index f1e688bd79..5017be8a8f 100644
--- a/plugins/azure-sites-backend/README.md
+++ b/plugins/azure-sites-backend/README.md
@@ -66,7 +66,7 @@ Here's how to get the backend plugin up and running:
```ts
import azureSites from './plugins/azure-sites';
- // Removed for clairty...
+ // Removed for clarity...
async function main() {
// ...
diff --git a/plugins/azure-sites-backend/src/service/router.ts b/plugins/azure-sites-backend/src/service/router.ts
index 67a4152eba..662332344b 100644
--- a/plugins/azure-sites-backend/src/service/router.ts
+++ b/plugins/azure-sites-backend/src/service/router.ts
@@ -77,7 +77,7 @@ export async function createRouter(
if (entity) {
const annotationName =
- entity.metadata?.annotations?.[AZURE_WEB_SITE_NAME_ANNOTATION];
+ entity.metadata.annotations?.[AZURE_WEB_SITE_NAME_ANNOTATION];
if (
annotationName &&
!(await azureSitesApi.validateSite(annotationName, name))
@@ -141,7 +141,7 @@ export async function createRouter(
annotationName &&
!(await azureSitesApi.validateSite(annotationName, name))
) {
- throw new NotFoundError();
+ throw new NotFoundError('annotation mismatched!');
}
const decision = permissions
diff --git a/plugins/azure-sites-common/api-report.md b/plugins/azure-sites-common/api-report.md
index 31ada5b0ce..e3f582107e 100644
--- a/plugins/azure-sites-common/api-report.md
+++ b/plugins/azure-sites-common/api-report.md
@@ -24,6 +24,14 @@ export type AzureSite = {
tags: {};
};
+// @public (undocumented)
+export type AzureSiteBackendRequest = {
+ subscription: string;
+ resourceGroup: string;
+ name: string;
+ entityRef: string;
+};
+
// @public (undocumented)
export type AzureSiteListRequest = {
name: string;
@@ -45,7 +53,6 @@ export type AzureSiteStartStopRequest = {
subscription: string;
resourceGroup: string;
name: string;
- entityRef?: string;
};
// (No @packageDocumentation comment for this package)
diff --git a/plugins/azure-sites-common/src/types.ts b/plugins/azure-sites-common/src/types.ts
index dc540599cb..4273085aab 100644
--- a/plugins/azure-sites-common/src/types.ts
+++ b/plugins/azure-sites-common/src/types.ts
@@ -45,5 +45,12 @@ export type AzureSiteStartStopRequest = {
subscription: string;
resourceGroup: string;
name: string;
- entityRef?: string;
+};
+
+/** @public */
+export type AzureSiteBackendRequest = {
+ subscription: string;
+ resourceGroup: string;
+ name: string;
+ entityRef: string;
};
diff --git a/plugins/azure-sites/api-report.md b/plugins/azure-sites/api-report.md
index abc10ec723..92e785caa2 100644
--- a/plugins/azure-sites/api-report.md
+++ b/plugins/azure-sites/api-report.md
@@ -6,9 +6,9 @@
///
import { ApiRef } from '@backstage/core-plugin-api';
+import { AzureSiteBackendRequest } from '@backstage/plugin-azure-sites-common';
import { AzureSiteListRequest } from '@backstage/plugin-azure-sites-common';
import { AzureSiteListResponse } from '@backstage/plugin-azure-sites-common';
-import { AzureSiteStartStopRequest } from '@backstage/plugin-azure-sites-common';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { DiscoveryApi } from '@backstage/core-plugin-api';
import { Entity } from '@backstage/catalog-model';
@@ -23,8 +23,8 @@ export const azureSiteApiRef: ApiRef;
// @public (undocumented)
export type AzureSitesApi = {
list: (request: AzureSiteListRequest) => Promise;
- start: (request: AzureSiteStartStopRequest) => Promise;
- stop: (request: AzureSiteStartStopRequest) => Promise;
+ start: (request: AzureSiteBackendRequest) => Promise;
+ stop: (request: AzureSiteBackendRequest) => Promise;
};
// @public (undocumented)
@@ -36,9 +36,9 @@ export class AzureSitesApiBackendClient implements AzureSitesApi {
// (undocumented)
list(request: AzureSiteListRequest): Promise;
// (undocumented)
- start(request: AzureSiteStartStopRequest): Promise;
+ start(request: AzureSiteBackendRequest): Promise;
// (undocumented)
- stop(request: AzureSiteStartStopRequest): Promise;
+ stop(request: AzureSiteBackendRequest): Promise;
}
// @public (undocumented)
diff --git a/plugins/azure-sites/src/api/AzureSitesApi.ts b/plugins/azure-sites/src/api/AzureSitesApi.ts
index 87a3b46a8d..067b2836a4 100644
--- a/plugins/azure-sites/src/api/AzureSitesApi.ts
+++ b/plugins/azure-sites/src/api/AzureSitesApi.ts
@@ -18,7 +18,7 @@ import { createApiRef } from '@backstage/core-plugin-api';
import {
AzureSiteListRequest,
AzureSiteListResponse,
- AzureSiteStartStopRequest,
+ AzureSiteBackendRequest,
} from '@backstage/plugin-azure-sites-common';
/** @public */
@@ -29,6 +29,6 @@ export const azureSiteApiRef = createApiRef({
/** @public */
export type AzureSitesApi = {
list: (request: AzureSiteListRequest) => Promise;
- start: (request: AzureSiteStartStopRequest) => Promise;
- stop: (request: AzureSiteStartStopRequest) => Promise;
+ start: (request: AzureSiteBackendRequest) => Promise;
+ stop: (request: AzureSiteBackendRequest) => Promise;
};
diff --git a/plugins/azure-sites/src/api/AzureSitesApiBackendClient.ts b/plugins/azure-sites/src/api/AzureSitesApiBackendClient.ts
index b482e80d92..59158df41a 100644
--- a/plugins/azure-sites/src/api/AzureSitesApiBackendClient.ts
+++ b/plugins/azure-sites/src/api/AzureSitesApiBackendClient.ts
@@ -18,7 +18,7 @@ import { AzureSitesApi } from './AzureSitesApi';
import {
AzureSiteListRequest,
AzureSiteListResponse,
- AzureSiteStartStopRequest,
+ AzureSiteBackendRequest,
} from '@backstage/plugin-azure-sites-common';
import { DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';
@@ -34,7 +34,7 @@ export class AzureSitesApiBackendClient implements AzureSitesApi {
this.identityApi = options.identityApi;
}
- async stop(request: AzureSiteStartStopRequest): Promise {
+ async stop(request: AzureSiteBackendRequest): Promise {
const url = `${await this.discoveryApi.getBaseUrl('azure-sites')}/${
request.subscription
}/${request.resourceGroup}/${request.name}/stop`;
@@ -51,7 +51,7 @@ export class AzureSitesApiBackendClient implements AzureSitesApi {
}),
});
}
- async start(request: AzureSiteStartStopRequest): Promise {
+ async start(request: AzureSiteBackendRequest): Promise {
const url = `${await this.discoveryApi.getBaseUrl('azure-sites')}/${
request.subscription
}/${request.resourceGroup}/${request.name}/start`;