updated azure sites backend types

Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com>

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() {
      // ...

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

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)

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;
 };

plugins/azure-sites/api-report.md

@@ -6,9 +6,9 @@
 /// <reference types="react" />
 
 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<AzureSitesApi>;
 // @public (undocumented)
 export type AzureSitesApi = {
   list: (request: AzureSiteListRequest) => Promise<AzureSiteListResponse>;
-  start: (request: AzureSiteStartStopRequest) => Promise<void>;
-  stop: (request: AzureSiteStartStopRequest) => Promise<void>;
+  start: (request: AzureSiteBackendRequest) => Promise<void>;
+  stop: (request: AzureSiteBackendRequest) => Promise<void>;
 };
 
 // @public (undocumented)
@@ -36,9 +36,9 @@ export class AzureSitesApiBackendClient implements AzureSitesApi {
   // (undocumented)
   list(request: AzureSiteListRequest): Promise<AzureSiteListResponse>;
   // (undocumented)
-  start(request: AzureSiteStartStopRequest): Promise<void>;
+  start(request: AzureSiteBackendRequest): Promise<void>;
   // (undocumented)
-  stop(request: AzureSiteStartStopRequest): Promise<void>;
+  stop(request: AzureSiteBackendRequest): Promise<void>;
 }
 
 // @public (undocumented)

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<AzureSitesApi>({
 /** @public */
 export type AzureSitesApi = {
   list: (request: AzureSiteListRequest) => Promise<AzureSiteListResponse>;
-  start: (request: AzureSiteStartStopRequest) => Promise<void>;
-  stop: (request: AzureSiteStartStopRequest) => Promise<void>;
+  start: (request: AzureSiteBackendRequest) => Promise<void>;
+  stop: (request: AzureSiteBackendRequest) => Promise<void>;
 };

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<void> {
+  async stop(request: AzureSiteBackendRequest): Promise<void> {
     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<void> {
+  async start(request: AzureSiteBackendRequest): Promise<void> {
     const url = `${await this.discoveryApi.getBaseUrl('azure-sites')}/${
       request.subscription
     }/${request.resourceGroup}/${request.name}/start`;