fix folder name

.eslintignore

@@ -23,6 +23,6 @@ LICENSE
 marketing/*/*
 licenses/*
 certifications/*
-ApiDocs/public/assets/*
+ApiReference/public/assets/*
 JavaScriptSDK/src/cli/server-monitor/out/scripts/prettify/*
 _test/*

.github/workflows/compile.api-reference.yaml

@@ -1,4 +1,4 @@
-name: Compile ApiDocs
+name: Compile ApiReference
 
 on:
   pull_request: 
@@ -20,5 +20,5 @@ jobs:
       - run: cd Common && npm install
       - run: cd Model && npm install
       - run: cd CommonServer && npm install
-      - run: cd ApiDocs && npm install && npm run compile
+      - run: cd ApiReference && npm install && npm run compile
   

.github/workflows/docker-build.api-reference.yml

@@ -21,4 +21,4 @@ jobs:
         
       # build image for home
       - name: build docker image
-        run: sudo docker build -f ./ApiDocs/Dockerfile .
+        run: sudo docker build -f ./ApiReference/Dockerfile .

.github/workflows/image-deployment.production.api-reference.yaml

@@ -1,4 +1,4 @@
-name: ApiDocs Production Image Deploy to DockerHub
+name: ApiReference Production Image Deploy to DockerHub
 
 on:
   push:
@@ -23,6 +23,6 @@ jobs:
         # Build and deploy api-reference.
       - run: sudo docker login --username $DOCKERHUB_USERNAME --password $DOCKERHUB_PASSWORD
       - run: sudo docker buildx create --use
-      - run: sudo docker buildx build --platform linux/amd64,linux/arm64 --tag oneuptime/api-reference:5.0.$CI_PIPELINE_ID --push -f ./ApiDocs/Dockerfile .
+      - run: sudo docker buildx build --platform linux/amd64,linux/arm64 --tag oneuptime/api-reference:5.0.$CI_PIPELINE_ID --push -f ./ApiReference/Dockerfile .
-      - run: sudo docker buildx build --platform linux/amd64,linux/arm64 --tag oneuptime/api-reference:release --push -f ./ApiDocs/Dockerfile .
+      - run: sudo docker buildx build --platform linux/amd64,linux/arm64 --tag oneuptime/api-reference:release --push -f ./ApiReference/Dockerfile .
       

.github/workflows/image-deployment.test.api-reference.yaml

@@ -1,4 +1,4 @@
-name: ApiDocs Test Image Deploy to DockerHub
+name: ApiReference Test Image Deploy to DockerHub
 
 on:
   push:
@@ -23,6 +23,6 @@ jobs:
         # Build and deploy api-reference.
       - run: sudo docker login --username $DOCKERHUB_USERNAME --password $DOCKERHUB_PASSWORD
       - run: sudo docker buildx create --use
-      - run: sudo docker buildx build --platform linux/amd64,linux/arm64 --tag oneuptime/api-reference:5.0.$CI_PIPELINE_ID-test --push -f ./ApiDocs/Dockerfile .
+      - run: sudo docker buildx build --platform linux/amd64,linux/arm64 --tag oneuptime/api-reference:5.0.$CI_PIPELINE_ID-test --push -f ./ApiReference/Dockerfile .
-      - run: sudo docker buildx build --platform linux/amd64,linux/arm64 --tag oneuptime/api-reference:test --push -f ./ApiDocs/Dockerfile .
+      - run: sudo docker buildx build --platform linux/amd64,linux/arm64 --tag oneuptime/api-reference:test --push -f ./ApiReference/Dockerfile .
       

.prettierignore

@@ -49,5 +49,5 @@ LICENSE
 marketing/*/*
 licenses/*
 certifications/*
-ApiDocs/public/assets/*
+ApiReference/public/assets/*
 JavaScriptSDK/src/cli/server-monitor/out/scripts/prettify/*

ApiReference/Dockerfile.tpl

@@ -46,7 +46,7 @@ RUN mkdir /usr/src/app
 WORKDIR /usr/src/app
 
 # Install app dependencies
-COPY ./ApiDocs/package*.json /usr/src/app/
+COPY ./ApiReference/package*.json /usr/src/app/
 RUN npm install
 
 
@@ -60,7 +60,7 @@ EXPOSE 1445
 CMD [ "npm", "run", "dev" ]
 {{ else }}
 # Copy app source
-COPY ./ApiDocs /usr/src/app
+COPY ./ApiReference /usr/src/app
 # Bundle app source
 RUN npm run compile
 #Run the app

ApiReference/README.md

@@ -1,6 +1,6 @@
 # OneUptime API Documentation
 
-[![Build Status](https://travis-ci.org/OneUptime/ApiDocs.svg?branch=master)](https://travis-ci.org/OneUptime/ApiDocs)
+[![Build Status](https://travis-ci.org/OneUptime/ApiReference.svg?branch=master)](https://travis-ci.org/OneUptime/ApiReference)
 
 This is the API Reference for OneUptime which is hosted at [https://oneuptime.com/reference](https://oneuptime.com/reference).
 

Ci/scripts/clean_install.sh

@@ -19,7 +19,7 @@ clean_install accounts
 clean_install backend
 clean_install home 
 clean_install StatusPage 
-clean_install ApiDocs
+clean_install ApiReference
 clean_install probe
 clean_install AdminDashboard
 clean_install InitScript

Ci/scripts/docker-build-all-and-push.sh

@@ -35,7 +35,7 @@ build accounts $1
 build backend $1
 build home $1
 build StatusPage $1
-build ApiDocs $1
+build ApiReference $1
 build probe $1
 build AdminDashboard $1
 build InitScript $1

Ci/scripts/hosts-setup.sh

@@ -22,9 +22,9 @@ sudo sed -i '/StatusPage/c\' /etc/hosts
 STATUSPAGE_IP=`sudo k describe svc oneuptime-status | grep Endpoints | cut -d ":" -f 2`
 echo $STATUSPAGE_IP'      status.app.local' | sudo tee -a /etc/hosts
 
-sudo sed -i '/ApiDocs/c\' /etc/hosts
+sudo sed -i '/ApiReference/c\' /etc/hosts
-APIDOCS_IP=`sudo k describe svc oneuptime-ApiDocs | grep Endpoints | cut -d ":" -f 2`
+ApiReference_IP=`sudo k describe svc oneuptime-ApiReference | grep Endpoints | cut -d ":" -f 2`
-echo $APIDOCS_IP'      ApiDocs.app.local' | sudo tee -a /etc/hosts
+echo $ApiReference_IP'      ApiReference.app.local' | sudo tee -a /etc/hosts
 
 sudo sed -i '/licensing/c\' /etc/hosts
 LICENSING_IP=`sudo k describe svc oneuptime-licensing | grep Endpoints | cut -d ":" -f 2`

Ci/scripts/production-rollback.sh

@@ -26,7 +26,7 @@ function check {
         rollback backend
         rollback home
         rollback StatusPage 
-        rollback ApiDocs
+        rollback ApiReference
         rollback probe
         rollback AdminDashboard
         rollback licensing
@@ -43,7 +43,7 @@ check accounts
 check backend
 check home 
 check StatusPage 
-check ApiDocs
+check ApiReference
 check probe-1
 check probe-2
 check AdminDashboard

Ci/scripts/staging-rollback.sh

@@ -32,7 +32,7 @@ function check {
         rollback backend
         rollback home
         rollback StatusPage 
-        rollback ApiDocs
+        rollback ApiReference
         rollback probe
         rollback AdminDashboard
         rollback licensing
@@ -49,7 +49,7 @@ check accounts
 check backend
 check home 
 check StatusPage 
-check ApiDocs
+check ApiReference
 check probe-1
 check probe-2
 check AdminDashboard

Ci/scripts/version-setup.sh

@@ -16,7 +16,7 @@ version accounts
 version backend
 version home 
 version StatusPage 
-version ApiDocs
+version ApiReference
 version probe
 version AdminDashboard
 version InitScript

Ci/spec/api-docs/audit.yaml

@@ -1,23 +1,23 @@
 ## ACCOUNTS
-audit_ApiDocs:
+audit_ApiReference:
     stage: BuildAndTest
     allow_failure: true
     script:
         - chmod +x ./ci/scripts/checkhash.sh
-        - export next_stage=`./ci/scripts/checkhash.sh audit_ApiDocs ApiDocs`
+        - export next_stage=`./ci/scripts/checkhash.sh audit_ApiReference ApiReference`
         - if [[ $next_stage == *"skip"* ]]; then exit ${CI_JOB_SKIP_EXIT_CODE:-0}; fi
         - sudo apt-get update
         - sudo apt-get install -y curl gcc
         - sudo apt-get install -y build-essential
         - curl -sL https://deb.nodesource.com/setup_15.x | sudo -E bash -
         - sudo apt-get install -y nodejs
-        - cd ApiDocs
+        - cd ApiReference
         - npm install
         - npm run audit
         - npm run dep-check
         - cd ..
         - chmod +x ./ci/scripts/storehash.sh
-        - ./ci/scripts/storehash.sh audit_ApiDocs ApiDocs
+        - ./ci/scripts/storehash.sh audit_ApiReference ApiReference
         - chmod +x ./ci/scripts/cleanup.sh
         - ./ci/scripts/cleanup.sh
     only:

Ci/spec/api-docs/rollback.yaml

@@ -1,15 +1,15 @@
-staging_rollback_ApiDocs:
+staging_rollback_ApiReference:
     stage: RollbackIfTestsFail
     script:
         - chmod +x ./ci/scripts/deployment-setup.sh
         - bash ./ci/scripts/deployment-setup.sh
         - chmod +x ./ci/scripts/deployment-staging-setup.sh
         - bash ./ci/scripts/deployment-staging-setup.sh
-        # Rollback ApiDocs
+        # Rollback ApiReference
         - chmod +x ./ci/scripts/job-status.sh
         - export smoke_test_staging_status=`./ci/scripts/job-status.sh smoke_test_staging`
         - if [[ $smoke_test_staging_status == \"success\" ]]; then exit 0; fi
-        - sudo kubectl rollout undo deployment/fi-ApiDocs
+        - sudo kubectl rollout undo deployment/fi-ApiReference
         - chmod +x ./ci/scripts/cleanup.sh
         - ./ci/scripts/cleanup.sh
     only:
@@ -18,18 +18,18 @@ staging_rollback_ApiDocs:
     except:
         - $STAGING_SMOKE_TEST_STATUS
 
-production_rollback_ApiDocs:
+production_rollback_ApiReference:
     stage: RollbackIfTestsFail
     script:
         - chmod +x ./ci/scripts/deployment-setup.sh
         - bash ./ci/scripts/deployment-setup.sh
         - chmod +x ./ci/scripts/deployment-production-setup.sh
         - bash ./ci/scripts/deployment-production-setup.sh
-        # Rollback ApiDocs
+        # Rollback ApiReference
         - chmod +x ./ci/scripts/job-status.sh
         - export smoke_test_production_status=`./ci/scripts/job-status.sh smoke_test_production`
         - if [[ $smoke_test_production_status == \"success\" ]]; then exit 0; fi
-        - sudo kubectl rollout undo deployment/fi-ApiDocs
+        - sudo kubectl rollout undo deployment/fi-ApiReference
         - chmod +x ./ci/scripts/cleanup.sh
         - ./ci/scripts/cleanup.sh
     only:

Ci/spec/e2e/docker-compose-test.yaml

@@ -21,7 +21,7 @@ e2e_docker_compose_test:
         - export DASHBOARD_URL=http://localhost:3000
         - export BACKEND_URL=http://localhost:3002
         - export STATUSPAGE_URL=http://localhost:3006
-        - export APIDOCS_URL=http://localhost:1445
+        - export ApiReference_URL=http://localhost:1445
         - cd tests
         - npm install
         - npm run test

Ci/spec/e2e/kubernetes-test.yaml

@@ -13,7 +13,7 @@ e2e_microk8s_test:
         - export DASHBOARD_URL=http://localhost/dashboard
         - export BACKEND_URL=http://localhost/api
         - export STATUSPAGE_URL=http://localhost/StatusPage
-        - export APIDOCS_URL=http://localhost/docs
+        - export ApiReference_URL=http://localhost/docs
         - export LICENSING_URL=http://localhost/license
         - cd tests
         - npm install

Ci/spec/tests/production.yaml

@@ -7,7 +7,7 @@ smoke_test_production:
         - export DASHBOARD_URL=https://oneuptime.com/dashboard
         - export BACKEND_URL=https://oneuptime.com/api
         - export STATUSPAGE_URL=https://statuspage.oneuptime.com
-        - export APIDOCS_URL=https://oneuptime.com/docs
+        - export ApiReference_URL=https://oneuptime.com/docs
         - export LICENSING_URL=https://oneuptime.com/license
         - cd tests
         - npm install

CommonServer/.env.tpl

@@ -40,7 +40,7 @@ DATA_INGESTOR_ROUTE={{ .Env.DATA_INGESTOR_ROUTE }}
 ACCOUNTS_ROUTE={{ .Env.ACCOUNTS_ROUTE }}
 HOME_ROUTE={{ .Env.HOME_ROUTE }}
 HELMCHARTS_ROUTE={{ .Env.HELMCHARTS_ROUTE }}
-APIDOCS_ROUTE={{ .Env.APIDOCS_ROUTE }}
+ApiReference_ROUTE={{ .Env.ApiReference_ROUTE }}
 IDENTITY_ROUTE={{ .Env.IDENTITY_ROUTE }}
 FILE_ROUTE={{ .Env.FILE_ROUTE }}
 WORKFLOW_ROUTE={{ .Env.WORKFLOW_ROUTE }}

CommonServer/Config.ts

@@ -140,8 +140,8 @@ export const WorkflowRoute: Route = new Route(
     process.env['WORKFLOW_ROUTE'] || '/workflow'
 );
 
-export const ApiDocsRoute: Route = new Route(
+export const ApiReferenceRoute: Route = new Route(
-    process.env['APIDOCS_ROUTE'] || '/api-reference'
+    process.env['ApiReference_ROUTE'] || '/api-reference'
 );
 
 export const AdminDashboardRoute: Route = new Route(

CommonUI/.env.tpl

@@ -7,7 +7,7 @@ DATA_INGESTOR_ROUTE={{ .Env.DATA_INGESTOR_ROUTE }}
 ACCOUNTS_ROUTE={{ .Env.ACCOUNTS_ROUTE }}
 HOME_ROUTE={{ .Env.HOME_ROUTE }}
 HELMCHARTS_ROUTE={{ .Env.HELMCHARTS_ROUTE }}
-APIDOCS_ROUTE={{ .Env.APIDOCS_ROUTE }}
+ApiReference_ROUTE={{ .Env.ApiReference_ROUTE }}
 IDENTITY_ROUTE={{ .Env.IDENTITY_ROUTE }}
 WORKFLOW_ROUTE={{ .Env.WORKFLOW_ROUTE }}
 FILE_ROUTE={{ .Env.FILE_ROUTE }}

CommonUI/src/Config.ts

@@ -40,7 +40,7 @@ export const INTEGRATION_ROUTE: Route = new Route(env('INTEGRATION_ROUTE'));
 
 export const HELM_ROUTE: Route = new Route(env('HELMCHART_ROUTE'));
 
-export const API_DOCS_ROUTE: Route = new Route(env('APIDOCS_ROUTE'));
+export const API_DOCS_ROUTE: Route = new Route(env('ApiReference_ROUTE'));
 
 export const ADMIN_DASHBOARD_ROUTE: Route = new Route(
     env('ADMINDASHBOARD_ROUTE')

Devops/update.sh

@@ -18,7 +18,7 @@ function update {
 update deployment/fi-accounts fi-accounts=oneuptime/accounts:$1
 update deployment/fi-dashboard fi-dashboard=oneuptime/dashboard:$1
 update deployment/fi-admin fi-admin=oneuptime/AdminDashboard:$1
-update deployment/fi-ApiDocs fi-ApiDocs=oneuptime/ApiDocs:$1
+update deployment/fi-ApiReference fi-ApiReference=oneuptime/ApiReference:$1
 update deployment/fi-app-scan fi-app-scan=oneuptime/ApplicationScanner:$1
 update deployment/fi-backend fi-backend=oneuptime/backend:$1
 update deployment/fi-cont-scan fi-cont-scan=oneuptime/ContainerScanner:$1

Docs/project-description.md

@@ -3,7 +3,7 @@
 -   `accounts` - A React project used for Authentication (Log in, Sign up, Forgot Password, etc.)
 -   `dashboard` - A React project for OneUptime user where user can interact with the OneUptime platform.
 -   `admin-dashobard` - React Project where admin can block users, delete projects and more.
--   `ApiDocs` - HTML/CSS project. A public reference of OneUptime documentation.
+-   `ApiReference` - HTML/CSS project. A public reference of OneUptime documentation.
 -   `backend` - NodeJS Service. It's OneUptime API's.
 -   `home` - HTML/CSS. Home Page / Marketing page of OneUptime.
 -   `HttpTestServer` - A test server used to test website monitors for OneUptime.

HelmChart/public/oneuptime/templates/api-docs.yaml

@@ -61,8 +61,8 @@ spec:
                           fieldRef:
                             fieldPath: spec.serviceAccountName
                   ports:
-                      - containerPort: {{ $.Values.host.apiDocsPort }}
+                      - containerPort: {{ $.Values.host.ApiReferencePort }}
-                        hostPort: {{ $.Values.host.apiDocsPort }}
+                        hostPort: {{ $.Values.host.ApiReferencePort }}
                         name: {{ printf "%s-%s" $.Release.Name "api-reference"  }}
             restartPolicy: {{ $.Values.image.restartPolicy }}
 
@@ -79,9 +79,9 @@ metadata:
     namespace: {{ $.Release.Namespace }}
 spec:
     ports:
-        - port: {{ $.Values.host.apiDocsServicePort }}
+        - port: {{ $.Values.host.ApiReferenceServicePort }}
           protocol: TCP
-          targetPort: {{ $.Values.host.apiDocsPort }}
+          targetPort: {{ $.Values.host.ApiReferencePort }}
     selector:
         app: {{ printf "%s-%s" $.Release.Name "api-reference"  }}
     type: ClusterIP

HelmChart/public/oneuptime/values.yaml

@@ -172,7 +172,7 @@ host:
   dashboardPort: 3000
   accountsPort: 3003
   helmChartPort: 3423
-  apiDocsPort: 1445
+  ApiReferencePort: 1445
   initScriptPort: 1447
   # if port 25 is avaialble and accessible
   # then we can use it as default port
@@ -184,7 +184,7 @@ host:
   realtimeServicePort: 80
   fetchResourcesServicePort: 80
   homeServicePort: 80
-  apiDocsServicePort: 80
+  ApiReferenceServicePort: 80
   statusPageHttpServicePort: 80
   statusPageHttpsServicePort: 443
   dashboardServicePort: 80

config.tpl.env

@@ -66,7 +66,7 @@ DATA_INGESTOR_ROUTE=/data-ingestor
 ACCOUNTS_ROUTE=/accounts
 HOME_ROUTE=
 HELMCHARTS_ROUTE=/charts
-APIDOCS_ROUTE=/reference
+ApiReference_ROUTE=/reference
 IDENTITY_ROUTE=/identity
 FILE_ROUTE=/file
 STATUS_PAGE_ROUTE=/status-page

docker-compose.tpl.yml

@@ -510,18 +510,18 @@ services:
         env_file:
             - ./Common/.env
             - ./CommonServer/.env
-            - ./ApiDocs/.env
+            - ./ApiReference/.env
         {{ if or (eq .Env.ENVIRONMENT "development") (eq .Env.ENVIRONMENT "ci")  }}
         build:
             network: host
             context: .
-            dockerfile: ./ApiDocs/Dockerfile
+            dockerfile: ./ApiReference/Dockerfile
         {{ else }}
         image:  oneuptime/api-reference:{{ .Env.APP_TAG }}
         {{ end }}
         {{ if eq .Env.ENVIRONMENT "development" }}
         volumes:
-            - ./ApiDocs:/usr/src/app
+            - ./ApiReference:/usr/src/app
             # Use node modules of the container and not host system.
             # https://stackoverflow.com/questions/29181032/add-a-volume-to-docker-but-exclude-a-sub-folder
             - /usr/src/app/node_modules/