fix(openchallenges): move OC API docs URL to app config (#2230)

* update config + env file for oc app * update footer params in html and ts scripts
Sage-Bionetworks · Oct 14, 2023 · 6b7f7ac · 6b7f7ac
1 parent 3a1da2c
commit 6b7f7ac
Show file tree

Hide file tree

Showing 22 changed files with 32 additions and 3 deletions.
diff --git a/apps/openchallenges/app/.env.example b/apps/openchallenges/app/.env.example
@@ -3,4 +3,5 @@ CSR_API_URL="http://localhost:8082/api/v1"
 DATA_UPDATED_ON="2023-09-26"
 ENVIRONMENT="production"
 GOOGLE_TAG_MANAGER_ID=""
-SSR_API_URL="http://openchallenges-api-gateway:8082/api/v1"
+SSR_API_URL="http://openchallenges-api-gateway:8082/api/v1"
+API_DOCS_URL="http://localhost:8000/api-docs"
diff --git a/apps/openchallenges/app/src/config/config.json b/apps/openchallenges/app/src/config/config.json
@@ -4,5 +4,6 @@
   "dataUpdatedOn": "yyyy-mm-dd",
   "environment": "development",
   "googleTagManagerId": "",
-  "ssrApiUrl": "http://openchallenges-api-gateway:8082/api/v1"
+  "ssrApiUrl": "http://openchallenges-api-gateway:8082/api/v1",
+  "apiDocsUrl": "http://localhost:8000/api-docs"
 }
diff --git a/apps/openchallenges/app/src/config/config.json.template b/apps/openchallenges/app/src/config/config.json.template
@@ -5,4 +5,5 @@
   "environment": "${ENVIRONMENT}",
   "googleTagManagerId": "${GOOGLE_TAG_MANAGER_ID}",
   "ssrApiUrl": "${SSR_API_URL}"
+  "apiDocsUrl": "${API_DOCS_URL}"
 }
diff --git a/libs/openchallenges/about/src/lib/about.component.html b/libs/openchallenges/about/src/lib/about.component.html
@@ -127,4 +127,5 @@ <h4 class="card-title text-center">Promote discoverability and reusability</h4>
   [dataUpdatedOn]="dataUpdatedOn"
   [privacyPolicyUrl]="privacyPolicyUrl"
   [termsOfUseUrl]="termsOfUseUrl"
+  [apiDocsUrl]="apiDocsUrl"
 />
diff --git a/libs/openchallenges/about/src/lib/about.component.ts b/libs/openchallenges/about/src/lib/about.component.ts
@@ -17,6 +17,7 @@ export class AboutComponent {
   public dataUpdatedOn: string;
   public privacyPolicyUrl: string;
   public termsOfUseUrl: string;
+  public apiDocsUrl: string;
 
   constructor(
     private readonly configService: ConfigService,
@@ -27,6 +28,7 @@ export class AboutComponent {
     this.dataUpdatedOn = this.configService.config.dataUpdatedOn;
     this.privacyPolicyUrl = this.configService.config.privacyPolicyUrl;
     this.termsOfUseUrl = this.configService.config.termsOfUseUrl;
+    this.apiDocsUrl = this.configService.config.apiDocsUrl;
     this.seoService.setData(getSeoData(), this.renderer2);
   }
 }
diff --git a/libs/openchallenges/challenge-search/src/lib/challenge-search.component.html b/libs/openchallenges/challenge-search/src/lib/challenge-search.component.html
@@ -186,4 +186,5 @@ <h3>Results ({{ searchResultsCount }})</h3>
   [dataUpdatedOn]="dataUpdatedOn"
   [privacyPolicyUrl]="privacyPolicyUrl"
   [termsOfUseUrl]="termsOfUseUrl"
+  [apiDocsUrl]="apiDocsUrl"
 />
diff --git a/libs/openchallenges/challenge-search/src/lib/challenge-search.component.ts b/libs/openchallenges/challenge-search/src/lib/challenge-search.component.ts
@@ -120,6 +120,7 @@ export class ChallengeSearchComponent
   public dataUpdatedOn: string;
   public privacyPolicyUrl: string;
   public termsOfUseUrl: string;
+  public apiDocsUrl: string;
   datePipe: DatePipe = new DatePipe('en-US');
 
   private query: BehaviorSubject<ChallengeSearchQuery> =
@@ -205,6 +206,7 @@ export class ChallengeSearchComponent
     this.dataUpdatedOn = this.configService.config.dataUpdatedOn;
     this.privacyPolicyUrl = this.configService.config.privacyPolicyUrl;
     this.termsOfUseUrl = this.configService.config.termsOfUseUrl;
+    this.apiDocsUrl = this.configService.config.apiDocsUrl;
     this.seoService.setData(getSeoData(), this.renderer2);
   }
 

diff --git a/libs/openchallenges/challenge/src/lib/challenge.component.html b/libs/openchallenges/challenge/src/lib/challenge.component.html
@@ -88,4 +88,5 @@ <h2>
   [dataUpdatedOn]="dataUpdatedOn"
   [privacyPolicyUrl]="privacyPolicyUrl"
   [termsOfUseUrl]="termsOfUseUrl"
+  [apiDocsUrl]="apiDocsUrl"
 />
diff --git a/libs/openchallenges/challenge/src/lib/challenge.component.ts b/libs/openchallenges/challenge/src/lib/challenge.component.ts
@@ -65,6 +65,7 @@ export class ChallengeComponent implements OnInit {
   public dataUpdatedOn: string;
   public privacyPolicyUrl: string;
   public termsOfUseUrl: string;
+  public apiDocsUrl: string;
 
   challenge$!: Observable<Challenge>;
   loggedIn = false;
@@ -88,6 +89,7 @@ export class ChallengeComponent implements OnInit {
     this.dataUpdatedOn = this.configService.config.dataUpdatedOn;
     this.privacyPolicyUrl = this.configService.config.privacyPolicyUrl;
     this.termsOfUseUrl = this.configService.config.termsOfUseUrl;
+    this.apiDocsUrl = this.configService.config.apiDocsUrl;
   }
 
   ngOnInit(): void {

diff --git a/libs/openchallenges/config/src/lib/app.config.ts b/libs/openchallenges/config/src/lib/app.config.ts
@@ -19,6 +19,7 @@ export interface AppConfig {
   privacyPolicyUrl: string;
   ssrApiUrl: string;
   termsOfUseUrl: string;
+  apiDocsUrl: string;
 }
 
 export const EMPTY_APP_CONFIG = {} as AppConfig;
diff --git a/libs/openchallenges/home/src/lib/home.component.html b/libs/openchallenges/home/src/lib/home.component.html
@@ -28,4 +28,5 @@ <h4>
   [dataUpdatedOn]="dataUpdatedOn"
   [privacyPolicyUrl]="privacyPolicyUrl"
   [termsOfUseUrl]="termsOfUseUrl"
+  [apiDocsUrl]="apiDocsUrl"
 />
diff --git a/libs/openchallenges/home/src/lib/home.component.ts b/libs/openchallenges/home/src/lib/home.component.ts
@@ -42,6 +42,7 @@ export class HomeComponent {
   public dataUpdatedOn: string;
   public privacyPolicyUrl: string;
   public termsOfUseUrl: string;
+  public apiDocsUrl: string;
 
   constructor(
     private readonly configService: ConfigService,
@@ -52,6 +53,7 @@ export class HomeComponent {
     this.dataUpdatedOn = this.configService.config.dataUpdatedOn;
     this.privacyPolicyUrl = this.configService.config.privacyPolicyUrl;
     this.termsOfUseUrl = this.configService.config.termsOfUseUrl;
+    this.apiDocsUrl = this.configService.config.apiDocsUrl;
     this.seoService.setData(getSeoData(), this.renderer2);
   }
 }
diff --git a/libs/openchallenges/not-found/src/lib/not-found.component.html b/libs/openchallenges/not-found/src/lib/not-found.component.html
@@ -20,4 +20,5 @@ <h1>Page Not Found</h1>
   [dataUpdatedOn]="dataUpdatedOn"
   [privacyPolicyUrl]="privacyPolicyUrl"
   [termsOfUseUrl]="termsOfUseUrl"
+  [apiDocsUrl]="apiDocsUrl"
 />
diff --git a/libs/openchallenges/not-found/src/lib/not-found.component.ts b/libs/openchallenges/not-found/src/lib/not-found.component.ts
@@ -24,11 +24,13 @@ export class NotFoundComponent {
   public dataUpdatedOn: string;
   public privacyPolicyUrl: string;
   public termsOfUseUrl: string;
+  public apiDocsUrl: string;
 
   constructor(private readonly configService: ConfigService) {
     this.appVersion = this.configService.config.appVersion;
     this.dataUpdatedOn = this.configService.config.dataUpdatedOn;
     this.privacyPolicyUrl = this.configService.config.privacyPolicyUrl;
     this.termsOfUseUrl = this.configService.config.termsOfUseUrl;
+    this.apiDocsUrl = this.configService.config.apiDocsUrl;
   }
 }
diff --git a/libs/openchallenges/org-profile/src/lib/org-profile.component.html b/libs/openchallenges/org-profile/src/lib/org-profile.component.html
@@ -71,4 +71,5 @@ <h2>
   [dataUpdatedOn]="dataUpdatedOn"
   [privacyPolicyUrl]="privacyPolicyUrl"
   [termsOfUseUrl]="termsOfUseUrl"
+  [apiDocsUrl]="apiDocsUrl"
 />
diff --git a/libs/openchallenges/org-profile/src/lib/org-profile.component.ts b/libs/openchallenges/org-profile/src/lib/org-profile.component.ts
@@ -72,6 +72,7 @@ export class OrgProfileComponent implements OnInit {
   public dataUpdatedOn: string;
   public privacyPolicyUrl: string;
   public termsOfUseUrl: string;
+  public apiDocsUrl: string;
 
   organization$!: Observable<Organization>;
   organizationAvatar$!: Observable<Avatar>;
@@ -95,6 +96,7 @@ export class OrgProfileComponent implements OnInit {
     this.dataUpdatedOn = this.configService.config.dataUpdatedOn;
     this.privacyPolicyUrl = this.configService.config.privacyPolicyUrl;
     this.termsOfUseUrl = this.configService.config.termsOfUseUrl;
+    this.apiDocsUrl = this.configService.config.apiDocsUrl;
   }
 
   ngOnInit(): void {

diff --git a/libs/openchallenges/org-search/src/lib/org-search.component.html b/libs/openchallenges/org-search/src/lib/org-search.component.html
@@ -83,4 +83,5 @@ <h3>Results ({{ searchResultsCount }})</h3>
   [dataUpdatedOn]="dataUpdatedOn"
   [privacyPolicyUrl]="privacyPolicyUrl"
   [termsOfUseUrl]="termsOfUseUrl"
+  [apiDocsUrl]="apiDocsUrl"
 />
diff --git a/libs/openchallenges/org-search/src/lib/org-search.component.ts b/libs/openchallenges/org-search/src/lib/org-search.component.ts
@@ -93,6 +93,7 @@ export class OrgSearchComponent implements OnInit, AfterContentInit, OnDestroy {
   public dataUpdatedOn: string;
   public privacyPolicyUrl: string;
   public termsOfUseUrl: string;
+  public apiDocsUrl: string;
 
   private query: BehaviorSubject<OrganizationSearchQuery> =
     new BehaviorSubject<OrganizationSearchQuery>({});
@@ -143,6 +144,7 @@ export class OrgSearchComponent implements OnInit, AfterContentInit, OnDestroy {
     this.dataUpdatedOn = this.configService.config.dataUpdatedOn;
     this.privacyPolicyUrl = this.configService.config.privacyPolicyUrl;
     this.termsOfUseUrl = this.configService.config.termsOfUseUrl;
+    this.apiDocsUrl = this.configService.config.apiDocsUrl;
     this.seoService.setData(getSeoData(), this.renderer2);
   }
 

diff --git a/libs/openchallenges/team/src/lib/team.component.html b/libs/openchallenges/team/src/lib/team.component.html
@@ -82,4 +82,5 @@ <h3 class="card-name">Jake Albrecht</h3>
   [dataUpdatedOn]="dataUpdatedOn"
   [privacyPolicyUrl]="privacyPolicyUrl"
   [termsOfUseUrl]="termsOfUseUrl"
+  [apiDocsUrl]="apiDocsUrl"
 />
diff --git a/libs/openchallenges/team/src/lib/team.component.ts b/libs/openchallenges/team/src/lib/team.component.ts
@@ -23,6 +23,7 @@ export class TeamComponent implements OnInit {
   public dataUpdatedOn: string;
   public privacyPolicyUrl: string;
   public termsOfUseUrl: string;
+  public apiDocsUrl: string;
   public logo$: Observable<Image> | undefined;
   public thomas$: Observable<Image> | undefined;
   public rong$: Observable<Image> | undefined;
@@ -40,6 +41,7 @@ export class TeamComponent implements OnInit {
     this.dataUpdatedOn = this.configService.config.dataUpdatedOn;
     this.privacyPolicyUrl = this.configService.config.privacyPolicyUrl;
     this.termsOfUseUrl = this.configService.config.termsOfUseUrl;
+    this.apiDocsUrl = this.configService.config.apiDocsUrl;
     this.seoService.setData(getSeoData(), this.renderer2);
   }
 

diff --git a/libs/openchallenges/ui/src/lib/footer/footer.component.html b/libs/openchallenges/ui/src/lib/footer/footer.component.html
@@ -11,7 +11,7 @@
         <li><a href="/team">Meet Our Team</a></li>
         <li>
           <a 
-            href="https://openchallenges.io/api-docs"
+            [href]="apiDocsUrl"
             title="Interactive documentation for OC API"
             rel="noopener noreferrer"
             target="_blank"

diff --git a/libs/openchallenges/ui/src/lib/footer/footer.component.ts b/libs/openchallenges/ui/src/lib/footer/footer.component.ts
@@ -13,4 +13,5 @@ export class FooterComponent {
   @Input({ required: true }) dataUpdatedOn = '';
   @Input({ required: true }) privacyPolicyUrl = '';
   @Input({ required: true }) termsOfUseUrl = '';
+  @Input({ required: true }) apiDocsUrl = '';
 }