feature: rename token to backstageToken and update the documentation

Signed-off-by: Hasan Oezdemir <21654050+nodify-at@users.noreply.github.com>

plugins/jenkins-backend/api-report.md

@@ -28,7 +28,7 @@ export class DefaultJenkinsInfoProvider implements JenkinsInfoProvider {
   getInstance(opt: {
     entityRef: CompoundEntityRef;
     jobFullName?: string;
-    token?: string;
+    backstageToken?: string;
   }): Promise<JenkinsInfo>;
   // (undocumented)
   static readonly NEW_JENKINS_ANNOTATION = 'jenkins.io/job-full-name';
@@ -69,7 +69,7 @@ export interface JenkinsInfoProvider {
   getInstance(options: {
     entityRef: CompoundEntityRef;
     jobFullName?: string;
-    token?: string;
+    backstageToken?: string;
   }): Promise<JenkinsInfo>;
 }
 

plugins/jenkins-backend/src/service/jenkinsInfoProvider.test.ts

@@ -186,7 +186,7 @@ describe('DefaultJenkinsInfoProvider', () => {
     await expect(provider.getInstance({ entityRef })).rejects.toThrowError();
 
     expect(mockCatalog.getEntityByRef).toBeCalledWith(entityRef, {
-      token: undefined,
+      backstageToken: undefined,
     });
   });
 
@@ -210,7 +210,7 @@ describe('DefaultJenkinsInfoProvider', () => {
     const info: JenkinsInfo = await provider.getInstance({ entityRef });
 
     expect(mockCatalog.getEntityByRef).toBeCalledWith(entityRef, {
-      token: undefined,
+      backstageToken: undefined,
     });
     expect(info).toStrictEqual({
       baseUrl: 'https://jenkins.example.com',
@@ -248,7 +248,7 @@ describe('DefaultJenkinsInfoProvider', () => {
     const info: JenkinsInfo = await provider.getInstance({ entityRef });
 
     expect(mockCatalog.getEntityByRef).toBeCalledWith(entityRef, {
-      token: undefined,
+      backstageToken: undefined,
     });
     expect(info).toMatchObject({
       baseUrl: 'https://jenkins.example.com',
@@ -287,7 +287,7 @@ describe('DefaultJenkinsInfoProvider', () => {
     const info: JenkinsInfo = await provider.getInstance({ entityRef });
 
     expect(mockCatalog.getEntityByRef).toBeCalledWith(entityRef, {
-      token: undefined,
+      backstageToken: undefined,
     });
     expect(info).toMatchObject({
       baseUrl: 'https://jenkins.example.com',
@@ -326,7 +326,7 @@ describe('DefaultJenkinsInfoProvider', () => {
     const info: JenkinsInfo = await provider.getInstance({ entityRef });
 
     expect(mockCatalog.getEntityByRef).toBeCalledWith(entityRef, {
-      token: undefined,
+      backstageToken: undefined,
     });
     expect(info).toMatchObject({
       baseUrl: 'https://jenkins-other.example.com',
@@ -354,7 +354,7 @@ describe('DefaultJenkinsInfoProvider', () => {
     const info: JenkinsInfo = await provider.getInstance({ entityRef });
 
     expect(mockCatalog.getEntityByRef).toBeCalledWith(entityRef, {
-      token: undefined,
+      backstageToken: undefined,
     });
     expect(info).toMatchObject({
       baseUrl: 'https://jenkins.example.com',
@@ -382,7 +382,7 @@ describe('DefaultJenkinsInfoProvider', () => {
     const info: JenkinsInfo = await provider.getInstance({ entityRef });
 
     expect(mockCatalog.getEntityByRef).toBeCalledWith(entityRef, {
-      token: undefined,
+      backstageToken: undefined,
     });
     expect(info).toMatchObject({
       baseUrl: 'https://jenkins.example.com',
@@ -415,7 +415,7 @@ describe('DefaultJenkinsInfoProvider', () => {
     const info: JenkinsInfo = await provider.getInstance({ entityRef });
 
     expect(mockCatalog.getEntityByRef).toBeCalledWith(entityRef, {
-      token: undefined,
+      backstageToken: undefined,
     });
     expect(info).toMatchObject({
       baseUrl: 'https://jenkins-other.example.com',

plugins/jenkins-backend/src/service/jenkinsInfoProvider.ts

@@ -33,7 +33,7 @@ export interface JenkinsInfoProvider {
      */
     jobFullName?: string;
 
-    token?: string;
+    backstageToken?: string;
   }): Promise<JenkinsInfo>;
 }
 
@@ -186,11 +186,11 @@ export class DefaultJenkinsInfoProvider implements JenkinsInfoProvider {
   async getInstance(opt: {
     entityRef: CompoundEntityRef;
     jobFullName?: string;
-    token?: string;
+    backstageToken?: string;
   }): Promise<JenkinsInfo> {
     // load entity
     const entity = await this.catalog.getEntityByRef(opt.entityRef, {
-      token: opt.token,
+      token: opt.backstageToken,
     });
     if (!entity) {
       throw new Error(

plugins/jenkins-backend/src/service/router.ts

@@ -70,7 +70,7 @@ export async function createRouter(
           namespace,
           name,
         },
-        token,
+        backstageToken: token,
       });
       const projects = await jenkinsApi.getProjects(jenkinsInfo, branchStr);
 
@@ -96,7 +96,7 @@ export async function createRouter(
           name,
         },
         jobFullName,
-        token,
+        backstageToken: token,
       });
 
       const build = await jenkinsApi.getBuild(