From 2bd0f5374746c2db2814c9235ea35c35321dc6c2 Mon Sep 17 00:00:00 2001 From: Simon Larsen Date: Wed, 5 Apr 2023 11:08:25 +0100 Subject: [PATCH] rename api ref --- ApiDocs/.env | 1 - {ApiDocs => ApiReference}/.dockerignore | 0 {ApiDocs => ApiReference}/.env.tpl | 0 {ApiDocs => ApiReference}/.gitattributes | 0 {ApiDocs => ApiReference}/.gitignore | 0 .../CodeExamples/Model/CountRequest.md | 0 .../CodeExamples/Model/CountResponse.md | 0 .../CodeExamples/Model/DeleteRequest.md | 0 .../CodeExamples/Model/DeleteResponse.md | 0 .../CodeExamples/Model/ItemRequest.md | 0 .../CodeExamples/Model/ItemResponse.md | 0 .../CodeExamples/Model/ListRequest.md | 0 .../CodeExamples/Model/ListResponse.md | 0 .../CodeExamples/Model/UpdateRequest.md | 0 .../CodeExamples/Model/UpdateResponse.md | 0 .../CodeExamples/Pagination/Request.md | 0 .../CodeExamples/Pagination/Response.md | 0 {ApiDocs => ApiReference}/Dockerfile.tpl | 0 {ApiDocs => ApiReference}/Index.ts | 15 +++++++------ {ApiDocs => ApiReference}/LICENSE | 0 {ApiDocs => ApiReference}/README.md | 2 +- .../Service/Authentication.ts | 0 {ApiDocs => ApiReference}/Service/Errors.ts | 0 .../Service/Introduction.ts | 0 {ApiDocs => ApiReference}/Service/Model.ts | 0 .../Service/PageNotFound.ts | 0 .../Service/Pagination.ts | 0 .../Service/Permissions.ts | 0 {ApiDocs => ApiReference}/Service/Queries.ts | 0 ApiReference/Service/Status.ts | 20 ++++++++++++++++++ {ApiDocs => ApiReference}/Utils/Resources.ts | 0 {ApiDocs => ApiReference}/nodemon.json | 0 {ApiDocs => ApiReference}/package-lock.json | 0 {ApiDocs => ApiReference}/package.json | 0 .../images/apple-touch-icon-114x114.png | Bin .../images/apple-touch-icon-120x120.png | Bin .../images/apple-touch-icon-144x144.png | Bin .../images/apple-touch-icon-152x152.png | Bin .../assets/images/apple-touch-icon-57x57.png | Bin .../assets/images/apple-touch-icon-60x60.png | Bin .../assets/images/apple-touch-icon-72x72.png | Bin .../assets/images/apple-touch-icon-76x76.png | Bin .../public/assets/images/favicon-128.png | Bin .../public/assets/images/favicon-16x16.png | Bin .../public/assets/images/favicon-196x196.png | Bin .../public/assets/images/favicon-32x32.png | Bin .../public/assets/images/favicon-96x96.png | Bin .../public/assets/images/favicon.ico | Bin .../favicons/android-chrome-144x144.png | Bin .../favicons/android-chrome-192x192.png | Bin .../favicons/android-chrome-256x256.png | Bin .../images/favicons/android-chrome-36x36.png | Bin .../favicons/android-chrome-384x384.png | Bin .../images/favicons/android-chrome-48x48.png | Bin .../favicons/android-chrome-512x512.png | Bin .../images/favicons/android-chrome-72x72.png | Bin .../images/favicons/android-chrome-96x96.png | Bin .../apple-touch-icon-114x114-precomposed.png | Bin .../favicons/apple-touch-icon-114x114.png | Bin .../apple-touch-icon-120x120-precomposed.png | Bin .../favicons/apple-touch-icon-120x120.png | Bin .../apple-touch-icon-144x144-precomposed.png | Bin .../favicons/apple-touch-icon-144x144.png | Bin .../apple-touch-icon-152x152-precomposed.png | Bin .../favicons/apple-touch-icon-152x152.png | Bin .../apple-touch-icon-180x180-precomposed.png | Bin .../favicons/apple-touch-icon-180x180.png | Bin .../apple-touch-icon-57x57-precomposed.png | Bin .../favicons/apple-touch-icon-57x57.png | Bin .../apple-touch-icon-60x60-precomposed.png | Bin .../favicons/apple-touch-icon-60x60.png | Bin .../apple-touch-icon-72x72-precomposed.png | Bin .../favicons/apple-touch-icon-72x72.png | Bin .../apple-touch-icon-76x76-precomposed.png | Bin .../favicons/apple-touch-icon-76x76.png | Bin .../favicons/apple-touch-icon-precomposed.png | Bin .../images/favicons/apple-touch-icon.png | Bin .../assets/images/favicons/browserconfig.xml | 0 .../assets/images/favicons/favicon-16x16.png | Bin .../images/favicons/favicon-194x194.png | Bin .../assets/images/favicons/favicon-32x32.png | Bin .../public/assets/images/favicons/favicon.ico | Bin .../assets/images/favicons/html_code.html | 0 .../assets/images/favicons/mstile-144x144.png | Bin .../assets/images/favicons/mstile-150x150.png | Bin .../assets/images/favicons/mstile-310x150.png | Bin .../assets/images/favicons/mstile-310x310.png | Bin .../assets/images/favicons/mstile-70x70.png | Bin .../images/favicons/safari-pinned-tab.svg | 0 .../assets/images/favicons/site.webmanifest | 0 .../public/assets/images/hou-bb.svg | 0 .../public/assets/images/hou-wb.svg | 0 .../public/assets/images/mstile-144x144.png | Bin .../public/assets/images/mstile-150x150.png | Bin .../public/assets/images/mstile-310x150.png | Bin .../public/assets/images/mstile-310x310.png | Bin .../public/assets/images/mstile-70x70.png | Bin .../public/assets/images/oneuptime.svg | 0 .../public/assets/images/vou-bb.svg | 0 .../public/assets/images/vou-wb.svg | 0 {ApiDocs => ApiReference}/public/favicon.ico | Bin {ApiDocs => ApiReference}/tsconfig.json | 0 {ApiDocs => ApiReference}/views/main/404.ejs | 0 .../views/main/authentication.ejs | 2 +- .../views/main/data-types.ejs | 0 .../views/main/errors.ejs | 0 .../views/main/introduction.ejs | 10 ++++----- .../views/main/model.ejs | 10 ++++----- .../views/main/pagination.ejs | 0 .../views/main/permissions.ejs | 0 ApiReference/views/main/status.ejs | 15 +++++++++++++ .../views/pages/index.ejs | 0 .../views/partials/code.ejs | 0 .../views/partials/footer.ejs | 0 .../views/partials/head.ejs | 0 .../views/partials/nav.ejs | 14 ++++++------ .../views/partials/sidenav.ejs | 0 Home/views/footer.ejs | 2 +- Home/views/nav.ejs | 2 +- Marketing/wikipedia.txt | 2 +- Nginx/default.tpl.conf | 2 +- config.tpl.env | 4 ++-- install.sh | 2 +- 123 files changed, 70 insertions(+), 33 deletions(-) delete mode 100644 ApiDocs/.env rename {ApiDocs => ApiReference}/.dockerignore (100%) rename {ApiDocs => ApiReference}/.env.tpl (100%) rename {ApiDocs => ApiReference}/.gitattributes (100%) rename {ApiDocs => ApiReference}/.gitignore (100%) rename {ApiDocs => ApiReference}/CodeExamples/Model/CountRequest.md (100%) rename {ApiDocs => ApiReference}/CodeExamples/Model/CountResponse.md (100%) rename {ApiDocs => ApiReference}/CodeExamples/Model/DeleteRequest.md (100%) rename {ApiDocs => ApiReference}/CodeExamples/Model/DeleteResponse.md (100%) rename {ApiDocs => ApiReference}/CodeExamples/Model/ItemRequest.md (100%) rename {ApiDocs => ApiReference}/CodeExamples/Model/ItemResponse.md (100%) rename {ApiDocs => ApiReference}/CodeExamples/Model/ListRequest.md (100%) rename {ApiDocs => ApiReference}/CodeExamples/Model/ListResponse.md (100%) rename {ApiDocs => ApiReference}/CodeExamples/Model/UpdateRequest.md (100%) rename {ApiDocs => ApiReference}/CodeExamples/Model/UpdateResponse.md (100%) rename {ApiDocs => ApiReference}/CodeExamples/Pagination/Request.md (100%) rename {ApiDocs => ApiReference}/CodeExamples/Pagination/Response.md (100%) rename {ApiDocs => ApiReference}/Dockerfile.tpl (100%) rename {ApiDocs => ApiReference}/Index.ts (86%) rename {ApiDocs => ApiReference}/LICENSE (100%) rename {ApiDocs => ApiReference}/README.md (84%) rename {ApiDocs => ApiReference}/Service/Authentication.ts (100%) rename {ApiDocs => ApiReference}/Service/Errors.ts (100%) rename {ApiDocs => ApiReference}/Service/Introduction.ts (100%) rename {ApiDocs => ApiReference}/Service/Model.ts (100%) rename {ApiDocs => ApiReference}/Service/PageNotFound.ts (100%) rename {ApiDocs => ApiReference}/Service/Pagination.ts (100%) rename {ApiDocs => ApiReference}/Service/Permissions.ts (100%) rename {ApiDocs => ApiReference}/Service/Queries.ts (100%) create mode 100644 ApiReference/Service/Status.ts rename {ApiDocs => ApiReference}/Utils/Resources.ts (100%) rename {ApiDocs => ApiReference}/nodemon.json (100%) rename {ApiDocs => ApiReference}/package-lock.json (100%) rename {ApiDocs => ApiReference}/package.json (100%) rename {ApiDocs => ApiReference}/public/assets/images/apple-touch-icon-114x114.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/apple-touch-icon-120x120.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/apple-touch-icon-144x144.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/apple-touch-icon-152x152.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/apple-touch-icon-57x57.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/apple-touch-icon-60x60.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/apple-touch-icon-72x72.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/apple-touch-icon-76x76.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicon-128.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicon-16x16.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicon-196x196.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicon-32x32.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicon-96x96.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicon.ico (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/android-chrome-144x144.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/android-chrome-192x192.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/android-chrome-256x256.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/android-chrome-36x36.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/android-chrome-384x384.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/android-chrome-48x48.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/android-chrome-512x512.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/android-chrome-72x72.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/android-chrome-96x96.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-114x114-precomposed.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-114x114.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-120x120-precomposed.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-120x120.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-144x144-precomposed.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-144x144.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-152x152-precomposed.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-152x152.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-180x180-precomposed.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-180x180.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-57x57-precomposed.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-57x57.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-60x60-precomposed.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-60x60.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-72x72-precomposed.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-72x72.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-76x76-precomposed.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-76x76.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon-precomposed.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/apple-touch-icon.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/browserconfig.xml (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/favicon-16x16.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/favicon-194x194.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/favicon-32x32.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/favicon.ico (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/html_code.html (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/mstile-144x144.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/mstile-150x150.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/mstile-310x150.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/mstile-310x310.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/mstile-70x70.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/safari-pinned-tab.svg (100%) rename {ApiDocs => ApiReference}/public/assets/images/favicons/site.webmanifest (100%) rename {ApiDocs => ApiReference}/public/assets/images/hou-bb.svg (100%) rename {ApiDocs => ApiReference}/public/assets/images/hou-wb.svg (100%) rename {ApiDocs => ApiReference}/public/assets/images/mstile-144x144.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/mstile-150x150.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/mstile-310x150.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/mstile-310x310.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/mstile-70x70.png (100%) rename {ApiDocs => ApiReference}/public/assets/images/oneuptime.svg (100%) rename {ApiDocs => ApiReference}/public/assets/images/vou-bb.svg (100%) rename {ApiDocs => ApiReference}/public/assets/images/vou-wb.svg (100%) rename {ApiDocs => ApiReference}/public/favicon.ico (100%) rename {ApiDocs => ApiReference}/tsconfig.json (100%) rename {ApiDocs => ApiReference}/views/main/404.ejs (100%) rename {ApiDocs => ApiReference}/views/main/authentication.ejs (98%) rename {ApiDocs => ApiReference}/views/main/data-types.ejs (100%) rename {ApiDocs => ApiReference}/views/main/errors.ejs (100%) rename {ApiDocs => ApiReference}/views/main/introduction.ejs (97%) rename {ApiDocs => ApiReference}/views/main/model.ejs (98%) rename {ApiDocs => ApiReference}/views/main/pagination.ejs (100%) rename {ApiDocs => ApiReference}/views/main/permissions.ejs (100%) create mode 100644 ApiReference/views/main/status.ejs rename {ApiDocs => ApiReference}/views/pages/index.ejs (100%) rename {ApiDocs => ApiReference}/views/partials/code.ejs (100%) rename {ApiDocs => ApiReference}/views/partials/footer.ejs (100%) rename {ApiDocs => ApiReference}/views/partials/head.ejs (100%) rename {ApiDocs => ApiReference}/views/partials/nav.ejs (97%) rename {ApiDocs => ApiReference}/views/partials/sidenav.ejs (100%) diff --git a/ApiDocs/.env b/ApiDocs/.env deleted file mode 100644 index 87e03e068a..0000000000 --- a/ApiDocs/.env +++ /dev/null @@ -1 +0,0 @@ -PORT=1445 \ No newline at end of file diff --git a/ApiDocs/.dockerignore b/ApiReference/.dockerignore similarity index 100% rename from ApiDocs/.dockerignore rename to ApiReference/.dockerignore diff --git a/ApiDocs/.env.tpl b/ApiReference/.env.tpl similarity index 100% rename from ApiDocs/.env.tpl rename to ApiReference/.env.tpl diff --git a/ApiDocs/.gitattributes b/ApiReference/.gitattributes similarity index 100% rename from ApiDocs/.gitattributes rename to ApiReference/.gitattributes diff --git a/ApiDocs/.gitignore b/ApiReference/.gitignore similarity index 100% rename from ApiDocs/.gitignore rename to ApiReference/.gitignore diff --git a/ApiDocs/CodeExamples/Model/CountRequest.md b/ApiReference/CodeExamples/Model/CountRequest.md similarity index 100% rename from ApiDocs/CodeExamples/Model/CountRequest.md rename to ApiReference/CodeExamples/Model/CountRequest.md diff --git a/ApiDocs/CodeExamples/Model/CountResponse.md b/ApiReference/CodeExamples/Model/CountResponse.md similarity index 100% rename from ApiDocs/CodeExamples/Model/CountResponse.md rename to ApiReference/CodeExamples/Model/CountResponse.md diff --git a/ApiDocs/CodeExamples/Model/DeleteRequest.md b/ApiReference/CodeExamples/Model/DeleteRequest.md similarity index 100% rename from ApiDocs/CodeExamples/Model/DeleteRequest.md rename to ApiReference/CodeExamples/Model/DeleteRequest.md diff --git a/ApiDocs/CodeExamples/Model/DeleteResponse.md b/ApiReference/CodeExamples/Model/DeleteResponse.md similarity index 100% rename from ApiDocs/CodeExamples/Model/DeleteResponse.md rename to ApiReference/CodeExamples/Model/DeleteResponse.md diff --git a/ApiDocs/CodeExamples/Model/ItemRequest.md b/ApiReference/CodeExamples/Model/ItemRequest.md similarity index 100% rename from ApiDocs/CodeExamples/Model/ItemRequest.md rename to ApiReference/CodeExamples/Model/ItemRequest.md diff --git a/ApiDocs/CodeExamples/Model/ItemResponse.md b/ApiReference/CodeExamples/Model/ItemResponse.md similarity index 100% rename from ApiDocs/CodeExamples/Model/ItemResponse.md rename to ApiReference/CodeExamples/Model/ItemResponse.md diff --git a/ApiDocs/CodeExamples/Model/ListRequest.md b/ApiReference/CodeExamples/Model/ListRequest.md similarity index 100% rename from ApiDocs/CodeExamples/Model/ListRequest.md rename to ApiReference/CodeExamples/Model/ListRequest.md diff --git a/ApiDocs/CodeExamples/Model/ListResponse.md b/ApiReference/CodeExamples/Model/ListResponse.md similarity index 100% rename from ApiDocs/CodeExamples/Model/ListResponse.md rename to ApiReference/CodeExamples/Model/ListResponse.md diff --git a/ApiDocs/CodeExamples/Model/UpdateRequest.md b/ApiReference/CodeExamples/Model/UpdateRequest.md similarity index 100% rename from ApiDocs/CodeExamples/Model/UpdateRequest.md rename to ApiReference/CodeExamples/Model/UpdateRequest.md diff --git a/ApiDocs/CodeExamples/Model/UpdateResponse.md b/ApiReference/CodeExamples/Model/UpdateResponse.md similarity index 100% rename from ApiDocs/CodeExamples/Model/UpdateResponse.md rename to ApiReference/CodeExamples/Model/UpdateResponse.md diff --git a/ApiDocs/CodeExamples/Pagination/Request.md b/ApiReference/CodeExamples/Pagination/Request.md similarity index 100% rename from ApiDocs/CodeExamples/Pagination/Request.md rename to ApiReference/CodeExamples/Pagination/Request.md diff --git a/ApiDocs/CodeExamples/Pagination/Response.md b/ApiReference/CodeExamples/Pagination/Response.md similarity index 100% rename from ApiDocs/CodeExamples/Pagination/Response.md rename to ApiReference/CodeExamples/Pagination/Response.md diff --git a/ApiDocs/Dockerfile.tpl b/ApiReference/Dockerfile.tpl similarity index 100% rename from ApiDocs/Dockerfile.tpl rename to ApiReference/Dockerfile.tpl diff --git a/ApiDocs/Index.ts b/ApiReference/Index.ts similarity index 86% rename from ApiDocs/Index.ts rename to ApiReference/Index.ts index 0c8026d89b..a34c4d02ff 100755 --- a/ApiDocs/Index.ts +++ b/ApiReference/Index.ts @@ -15,12 +15,13 @@ import AuthenticationServiceHandler from './Service/Authentication'; import PageNotFoundServiceHandler from './Service/PageNotFound'; import ModelServiceHandler from './Service/Model'; import PaginationServiceHandler from './Service/Pagination'; +import StatusServiceHandler from './Service/Status'; import Dictionary from 'Common/Types/Dictionary'; const ResourceDictionary: Dictionary = ResourceUtil.getReosurceDictionaryByPath(); -const APP_NAME: string = 'docs'; +const APP_NAME: string = 'reference'; const app: ExpressApplication = Express.getExpressApp(); @@ -32,24 +33,24 @@ app.set('view engine', 'ejs'); app.use(ExpressStatic(path.join(__dirname, 'public'), { maxAge: 2592000 })); app.use( - '/docs', + '/reference', ExpressStatic(path.join(__dirname, 'public'), { maxAge: 2592000 }) ); // Index page -app.get(['/docs'], (_req: ExpressRequest, res: ExpressResponse) => { - return res.redirect('/docs/introduction'); +app.get(['/reference'], (_req: ExpressRequest, res: ExpressResponse) => { + return res.redirect('/reference/introduction'); }); app.get( - ['/docs/page-not-found'], + ['/reference/page-not-found'], (req: ExpressRequest, res: ExpressResponse) => { return PageNotFoundServiceHandler.executeResponse(req, res); } ); // All Pages -app.get(['/docs/:page'], (req: ExpressRequest, res: ExpressResponse) => { +app.get(['/reference/:page'], (req: ExpressRequest, res: ExpressResponse) => { const page: string | undefined = req.params['page']; if (!page) { @@ -69,6 +70,8 @@ app.get(['/docs/:page'], (req: ExpressRequest, res: ExpressResponse) => { return ErrorServiceHandler.executeResponse(req, res); } else if (req.params['page'] === 'introduction') { return IntroductionServiceHandler.executeResponse(req, res); + } else if (req.params['page'] === 'status') { + return StatusServiceHandler.executeResponse(req, res); } else if (currentResource) { return ModelServiceHandler.executeResponse(req, res); } diff --git a/ApiDocs/LICENSE b/ApiReference/LICENSE similarity index 100% rename from ApiDocs/LICENSE rename to ApiReference/LICENSE diff --git a/ApiDocs/README.md b/ApiReference/README.md similarity index 84% rename from ApiDocs/README.md rename to ApiReference/README.md index ec5bd8f10c..08538946be 100755 --- a/ApiDocs/README.md +++ b/ApiReference/README.md @@ -2,7 +2,7 @@ [![Build Status](https://travis-ci.org/OneUptime/ApiDocs.svg?branch=master)](https://travis-ci.org/OneUptime/ApiDocs) -This is the API Reference for OneUptime which is hosted at [https://oneuptime.com/docs](https://oneuptime.com/docs). +This is the API Reference for OneUptime which is hosted at [https://oneuptime.com/reference](https://oneuptime.com/reference). # Contribute diff --git a/ApiDocs/Service/Authentication.ts b/ApiReference/Service/Authentication.ts similarity index 100% rename from ApiDocs/Service/Authentication.ts rename to ApiReference/Service/Authentication.ts diff --git a/ApiDocs/Service/Errors.ts b/ApiReference/Service/Errors.ts similarity index 100% rename from ApiDocs/Service/Errors.ts rename to ApiReference/Service/Errors.ts diff --git a/ApiDocs/Service/Introduction.ts b/ApiReference/Service/Introduction.ts similarity index 100% rename from ApiDocs/Service/Introduction.ts rename to ApiReference/Service/Introduction.ts diff --git a/ApiDocs/Service/Model.ts b/ApiReference/Service/Model.ts similarity index 100% rename from ApiDocs/Service/Model.ts rename to ApiReference/Service/Model.ts diff --git a/ApiDocs/Service/PageNotFound.ts b/ApiReference/Service/PageNotFound.ts similarity index 100% rename from ApiDocs/Service/PageNotFound.ts rename to ApiReference/Service/PageNotFound.ts diff --git a/ApiDocs/Service/Pagination.ts b/ApiReference/Service/Pagination.ts similarity index 100% rename from ApiDocs/Service/Pagination.ts rename to ApiReference/Service/Pagination.ts diff --git a/ApiDocs/Service/Permissions.ts b/ApiReference/Service/Permissions.ts similarity index 100% rename from ApiDocs/Service/Permissions.ts rename to ApiReference/Service/Permissions.ts diff --git a/ApiDocs/Service/Queries.ts b/ApiReference/Service/Queries.ts similarity index 100% rename from ApiDocs/Service/Queries.ts rename to ApiReference/Service/Queries.ts diff --git a/ApiReference/Service/Status.ts b/ApiReference/Service/Status.ts new file mode 100644 index 0000000000..8a0e9a4fca --- /dev/null +++ b/ApiReference/Service/Status.ts @@ -0,0 +1,20 @@ +import { ExpressRequest, ExpressResponse } from 'CommonServer/Utils/Express'; +import ResourceUtil, { ModelDocumentation } from '../Utils/Resources'; + +const Resources: Array = ResourceUtil.getResources(); + +export default class ServiceHandler { + public static async executeResponse( + _req: ExpressRequest, + res: ExpressResponse + ): Promise { + res.status(200); + return res.render('pages/index', { + page: 'status', + pageTitle: 'Status', + pageDescription: "200 - Success", + resources: Resources, + pageData: {}, + }); + } +} diff --git a/ApiDocs/Utils/Resources.ts b/ApiReference/Utils/Resources.ts similarity index 100% rename from ApiDocs/Utils/Resources.ts rename to ApiReference/Utils/Resources.ts diff --git a/ApiDocs/nodemon.json b/ApiReference/nodemon.json similarity index 100% rename from ApiDocs/nodemon.json rename to ApiReference/nodemon.json diff --git a/ApiDocs/package-lock.json b/ApiReference/package-lock.json similarity index 100% rename from ApiDocs/package-lock.json rename to ApiReference/package-lock.json diff --git a/ApiDocs/package.json b/ApiReference/package.json similarity index 100% rename from ApiDocs/package.json rename to ApiReference/package.json diff --git a/ApiDocs/public/assets/images/apple-touch-icon-114x114.png b/ApiReference/public/assets/images/apple-touch-icon-114x114.png similarity index 100% rename from ApiDocs/public/assets/images/apple-touch-icon-114x114.png rename to ApiReference/public/assets/images/apple-touch-icon-114x114.png diff --git a/ApiDocs/public/assets/images/apple-touch-icon-120x120.png b/ApiReference/public/assets/images/apple-touch-icon-120x120.png similarity index 100% rename from ApiDocs/public/assets/images/apple-touch-icon-120x120.png rename to ApiReference/public/assets/images/apple-touch-icon-120x120.png diff --git a/ApiDocs/public/assets/images/apple-touch-icon-144x144.png b/ApiReference/public/assets/images/apple-touch-icon-144x144.png similarity index 100% rename from ApiDocs/public/assets/images/apple-touch-icon-144x144.png rename to ApiReference/public/assets/images/apple-touch-icon-144x144.png diff --git a/ApiDocs/public/assets/images/apple-touch-icon-152x152.png b/ApiReference/public/assets/images/apple-touch-icon-152x152.png similarity index 100% rename from ApiDocs/public/assets/images/apple-touch-icon-152x152.png rename to ApiReference/public/assets/images/apple-touch-icon-152x152.png diff --git a/ApiDocs/public/assets/images/apple-touch-icon-57x57.png b/ApiReference/public/assets/images/apple-touch-icon-57x57.png similarity index 100% rename from ApiDocs/public/assets/images/apple-touch-icon-57x57.png rename to ApiReference/public/assets/images/apple-touch-icon-57x57.png diff --git a/ApiDocs/public/assets/images/apple-touch-icon-60x60.png b/ApiReference/public/assets/images/apple-touch-icon-60x60.png similarity index 100% rename from ApiDocs/public/assets/images/apple-touch-icon-60x60.png rename to ApiReference/public/assets/images/apple-touch-icon-60x60.png diff --git a/ApiDocs/public/assets/images/apple-touch-icon-72x72.png b/ApiReference/public/assets/images/apple-touch-icon-72x72.png similarity index 100% rename from ApiDocs/public/assets/images/apple-touch-icon-72x72.png rename to ApiReference/public/assets/images/apple-touch-icon-72x72.png diff --git a/ApiDocs/public/assets/images/apple-touch-icon-76x76.png b/ApiReference/public/assets/images/apple-touch-icon-76x76.png similarity index 100% rename from ApiDocs/public/assets/images/apple-touch-icon-76x76.png rename to ApiReference/public/assets/images/apple-touch-icon-76x76.png diff --git a/ApiDocs/public/assets/images/favicon-128.png b/ApiReference/public/assets/images/favicon-128.png similarity index 100% rename from ApiDocs/public/assets/images/favicon-128.png rename to ApiReference/public/assets/images/favicon-128.png diff --git a/ApiDocs/public/assets/images/favicon-16x16.png b/ApiReference/public/assets/images/favicon-16x16.png similarity index 100% rename from ApiDocs/public/assets/images/favicon-16x16.png rename to ApiReference/public/assets/images/favicon-16x16.png diff --git a/ApiDocs/public/assets/images/favicon-196x196.png b/ApiReference/public/assets/images/favicon-196x196.png similarity index 100% rename from ApiDocs/public/assets/images/favicon-196x196.png rename to ApiReference/public/assets/images/favicon-196x196.png diff --git a/ApiDocs/public/assets/images/favicon-32x32.png b/ApiReference/public/assets/images/favicon-32x32.png similarity index 100% rename from ApiDocs/public/assets/images/favicon-32x32.png rename to ApiReference/public/assets/images/favicon-32x32.png diff --git a/ApiDocs/public/assets/images/favicon-96x96.png b/ApiReference/public/assets/images/favicon-96x96.png similarity index 100% rename from ApiDocs/public/assets/images/favicon-96x96.png rename to ApiReference/public/assets/images/favicon-96x96.png diff --git a/ApiDocs/public/assets/images/favicon.ico b/ApiReference/public/assets/images/favicon.ico similarity index 100% rename from ApiDocs/public/assets/images/favicon.ico rename to ApiReference/public/assets/images/favicon.ico diff --git a/ApiDocs/public/assets/images/favicons/android-chrome-144x144.png b/ApiReference/public/assets/images/favicons/android-chrome-144x144.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/android-chrome-144x144.png rename to ApiReference/public/assets/images/favicons/android-chrome-144x144.png diff --git a/ApiDocs/public/assets/images/favicons/android-chrome-192x192.png b/ApiReference/public/assets/images/favicons/android-chrome-192x192.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/android-chrome-192x192.png rename to ApiReference/public/assets/images/favicons/android-chrome-192x192.png diff --git a/ApiDocs/public/assets/images/favicons/android-chrome-256x256.png b/ApiReference/public/assets/images/favicons/android-chrome-256x256.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/android-chrome-256x256.png rename to ApiReference/public/assets/images/favicons/android-chrome-256x256.png diff --git a/ApiDocs/public/assets/images/favicons/android-chrome-36x36.png b/ApiReference/public/assets/images/favicons/android-chrome-36x36.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/android-chrome-36x36.png rename to ApiReference/public/assets/images/favicons/android-chrome-36x36.png diff --git a/ApiDocs/public/assets/images/favicons/android-chrome-384x384.png b/ApiReference/public/assets/images/favicons/android-chrome-384x384.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/android-chrome-384x384.png rename to ApiReference/public/assets/images/favicons/android-chrome-384x384.png diff --git a/ApiDocs/public/assets/images/favicons/android-chrome-48x48.png b/ApiReference/public/assets/images/favicons/android-chrome-48x48.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/android-chrome-48x48.png rename to ApiReference/public/assets/images/favicons/android-chrome-48x48.png diff --git a/ApiDocs/public/assets/images/favicons/android-chrome-512x512.png b/ApiReference/public/assets/images/favicons/android-chrome-512x512.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/android-chrome-512x512.png rename to ApiReference/public/assets/images/favicons/android-chrome-512x512.png diff --git a/ApiDocs/public/assets/images/favicons/android-chrome-72x72.png b/ApiReference/public/assets/images/favicons/android-chrome-72x72.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/android-chrome-72x72.png rename to ApiReference/public/assets/images/favicons/android-chrome-72x72.png diff --git a/ApiDocs/public/assets/images/favicons/android-chrome-96x96.png b/ApiReference/public/assets/images/favicons/android-chrome-96x96.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/android-chrome-96x96.png rename to ApiReference/public/assets/images/favicons/android-chrome-96x96.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-114x114-precomposed.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-114x114-precomposed.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-114x114-precomposed.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-114x114-precomposed.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-114x114.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-114x114.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-114x114.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-114x114.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-120x120-precomposed.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-120x120-precomposed.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-120x120-precomposed.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-120x120-precomposed.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-120x120.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-120x120.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-120x120.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-120x120.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-144x144-precomposed.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-144x144-precomposed.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-144x144-precomposed.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-144x144-precomposed.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-144x144.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-144x144.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-144x144.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-144x144.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-152x152-precomposed.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-152x152-precomposed.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-152x152-precomposed.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-152x152-precomposed.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-152x152.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-152x152.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-152x152.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-152x152.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-180x180-precomposed.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-180x180-precomposed.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-180x180-precomposed.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-180x180-precomposed.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-180x180.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-180x180.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-180x180.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-180x180.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-57x57-precomposed.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-57x57-precomposed.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-57x57-precomposed.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-57x57-precomposed.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-57x57.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-57x57.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-57x57.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-57x57.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-60x60-precomposed.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-60x60-precomposed.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-60x60-precomposed.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-60x60-precomposed.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-60x60.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-60x60.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-60x60.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-60x60.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-72x72-precomposed.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-72x72-precomposed.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-72x72-precomposed.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-72x72-precomposed.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-72x72.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-72x72.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-72x72.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-72x72.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-76x76-precomposed.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-76x76-precomposed.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-76x76-precomposed.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-76x76-precomposed.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-76x76.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-76x76.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-76x76.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-76x76.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon-precomposed.png b/ApiReference/public/assets/images/favicons/apple-touch-icon-precomposed.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon-precomposed.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon-precomposed.png diff --git a/ApiDocs/public/assets/images/favicons/apple-touch-icon.png b/ApiReference/public/assets/images/favicons/apple-touch-icon.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/apple-touch-icon.png rename to ApiReference/public/assets/images/favicons/apple-touch-icon.png diff --git a/ApiDocs/public/assets/images/favicons/browserconfig.xml b/ApiReference/public/assets/images/favicons/browserconfig.xml similarity index 100% rename from ApiDocs/public/assets/images/favicons/browserconfig.xml rename to ApiReference/public/assets/images/favicons/browserconfig.xml diff --git a/ApiDocs/public/assets/images/favicons/favicon-16x16.png b/ApiReference/public/assets/images/favicons/favicon-16x16.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/favicon-16x16.png rename to ApiReference/public/assets/images/favicons/favicon-16x16.png diff --git a/ApiDocs/public/assets/images/favicons/favicon-194x194.png b/ApiReference/public/assets/images/favicons/favicon-194x194.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/favicon-194x194.png rename to ApiReference/public/assets/images/favicons/favicon-194x194.png diff --git a/ApiDocs/public/assets/images/favicons/favicon-32x32.png b/ApiReference/public/assets/images/favicons/favicon-32x32.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/favicon-32x32.png rename to ApiReference/public/assets/images/favicons/favicon-32x32.png diff --git a/ApiDocs/public/assets/images/favicons/favicon.ico b/ApiReference/public/assets/images/favicons/favicon.ico similarity index 100% rename from ApiDocs/public/assets/images/favicons/favicon.ico rename to ApiReference/public/assets/images/favicons/favicon.ico diff --git a/ApiDocs/public/assets/images/favicons/html_code.html b/ApiReference/public/assets/images/favicons/html_code.html similarity index 100% rename from ApiDocs/public/assets/images/favicons/html_code.html rename to ApiReference/public/assets/images/favicons/html_code.html diff --git a/ApiDocs/public/assets/images/favicons/mstile-144x144.png b/ApiReference/public/assets/images/favicons/mstile-144x144.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/mstile-144x144.png rename to ApiReference/public/assets/images/favicons/mstile-144x144.png diff --git a/ApiDocs/public/assets/images/favicons/mstile-150x150.png b/ApiReference/public/assets/images/favicons/mstile-150x150.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/mstile-150x150.png rename to ApiReference/public/assets/images/favicons/mstile-150x150.png diff --git a/ApiDocs/public/assets/images/favicons/mstile-310x150.png b/ApiReference/public/assets/images/favicons/mstile-310x150.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/mstile-310x150.png rename to ApiReference/public/assets/images/favicons/mstile-310x150.png diff --git a/ApiDocs/public/assets/images/favicons/mstile-310x310.png b/ApiReference/public/assets/images/favicons/mstile-310x310.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/mstile-310x310.png rename to ApiReference/public/assets/images/favicons/mstile-310x310.png diff --git a/ApiDocs/public/assets/images/favicons/mstile-70x70.png b/ApiReference/public/assets/images/favicons/mstile-70x70.png similarity index 100% rename from ApiDocs/public/assets/images/favicons/mstile-70x70.png rename to ApiReference/public/assets/images/favicons/mstile-70x70.png diff --git a/ApiDocs/public/assets/images/favicons/safari-pinned-tab.svg b/ApiReference/public/assets/images/favicons/safari-pinned-tab.svg similarity index 100% rename from ApiDocs/public/assets/images/favicons/safari-pinned-tab.svg rename to ApiReference/public/assets/images/favicons/safari-pinned-tab.svg diff --git a/ApiDocs/public/assets/images/favicons/site.webmanifest b/ApiReference/public/assets/images/favicons/site.webmanifest similarity index 100% rename from ApiDocs/public/assets/images/favicons/site.webmanifest rename to ApiReference/public/assets/images/favicons/site.webmanifest diff --git a/ApiDocs/public/assets/images/hou-bb.svg b/ApiReference/public/assets/images/hou-bb.svg similarity index 100% rename from ApiDocs/public/assets/images/hou-bb.svg rename to ApiReference/public/assets/images/hou-bb.svg diff --git a/ApiDocs/public/assets/images/hou-wb.svg b/ApiReference/public/assets/images/hou-wb.svg similarity index 100% rename from ApiDocs/public/assets/images/hou-wb.svg rename to ApiReference/public/assets/images/hou-wb.svg diff --git a/ApiDocs/public/assets/images/mstile-144x144.png b/ApiReference/public/assets/images/mstile-144x144.png similarity index 100% rename from ApiDocs/public/assets/images/mstile-144x144.png rename to ApiReference/public/assets/images/mstile-144x144.png diff --git a/ApiDocs/public/assets/images/mstile-150x150.png b/ApiReference/public/assets/images/mstile-150x150.png similarity index 100% rename from ApiDocs/public/assets/images/mstile-150x150.png rename to ApiReference/public/assets/images/mstile-150x150.png diff --git a/ApiDocs/public/assets/images/mstile-310x150.png b/ApiReference/public/assets/images/mstile-310x150.png similarity index 100% rename from ApiDocs/public/assets/images/mstile-310x150.png rename to ApiReference/public/assets/images/mstile-310x150.png diff --git a/ApiDocs/public/assets/images/mstile-310x310.png b/ApiReference/public/assets/images/mstile-310x310.png similarity index 100% rename from ApiDocs/public/assets/images/mstile-310x310.png rename to ApiReference/public/assets/images/mstile-310x310.png diff --git a/ApiDocs/public/assets/images/mstile-70x70.png b/ApiReference/public/assets/images/mstile-70x70.png similarity index 100% rename from ApiDocs/public/assets/images/mstile-70x70.png rename to ApiReference/public/assets/images/mstile-70x70.png diff --git a/ApiDocs/public/assets/images/oneuptime.svg b/ApiReference/public/assets/images/oneuptime.svg similarity index 100% rename from ApiDocs/public/assets/images/oneuptime.svg rename to ApiReference/public/assets/images/oneuptime.svg diff --git a/ApiDocs/public/assets/images/vou-bb.svg b/ApiReference/public/assets/images/vou-bb.svg similarity index 100% rename from ApiDocs/public/assets/images/vou-bb.svg rename to ApiReference/public/assets/images/vou-bb.svg diff --git a/ApiDocs/public/assets/images/vou-wb.svg b/ApiReference/public/assets/images/vou-wb.svg similarity index 100% rename from ApiDocs/public/assets/images/vou-wb.svg rename to ApiReference/public/assets/images/vou-wb.svg diff --git a/ApiDocs/public/favicon.ico b/ApiReference/public/favicon.ico similarity index 100% rename from ApiDocs/public/favicon.ico rename to ApiReference/public/favicon.ico diff --git a/ApiDocs/tsconfig.json b/ApiReference/tsconfig.json similarity index 100% rename from ApiDocs/tsconfig.json rename to ApiReference/tsconfig.json diff --git a/ApiDocs/views/main/404.ejs b/ApiReference/views/main/404.ejs similarity index 100% rename from ApiDocs/views/main/404.ejs rename to ApiReference/views/main/404.ejs diff --git a/ApiDocs/views/main/authentication.ejs b/ApiReference/views/main/authentication.ejs similarity index 98% rename from ApiDocs/views/main/authentication.ejs rename to ApiReference/views/main/authentication.ejs index 18725ab510..86e59cc914 100644 --- a/ApiDocs/views/main/authentication.ejs +++ b/ApiReference/views/main/authentication.ejs @@ -6,7 +6,7 @@ Generate an API Key

Please head over to Project Settings > API Keys. Create a new API Key. Please note: New API Keys have no permissions assigned to them, so you will have to assign a permission before you can use it.

- + Read more about permissions

+ href="/reference/authentication"> Read more

+ href="/reference/pagination"> Read more

+ href="/reference/errors"> Read more

+ href="/reference/permissions"> Read more

<%= pageData.featuredResources[i].name -%>

<%= pageData.featuredResources[i].description -%>

diff --git a/ApiDocs/views/main/model.ejs b/ApiReference/views/main/model.ejs similarity index 98% rename from ApiDocs/views/main/model.ejs rename to ApiReference/views/main/model.ejs index 782aa6c4b6..5388cf7168 100644 --- a/ApiDocs/views/main/model.ejs +++ b/ApiReference/views/main/model.ejs @@ -298,7 +298,7 @@
query
Description
-

If you would like to filter on <%= pageData.title -%>. You can specify include a query here. For more information, please check out writing queries here.

+

If you would like to filter on <%= pageData.title -%>. You can specify include a query here. For more information, please check out writing queries here.

@@ -311,7 +311,7 @@
select
Description
-

By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.

+

By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.

@@ -323,7 +323,7 @@
sort
Description
-

Objects will be sorted based on created date by default. You can change the sort order by passing please check how to select here.

+

Objects will be sorted based on created date by default. You can change the sort order by passing please check how to select here.

@@ -386,7 +386,7 @@
select
Description
-

By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.

+

By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.

@@ -433,7 +433,7 @@
query
Description
-

If you would like to filter on <%= pageData.title -%>. You can specify include a query here. For more information, please check out writing queries here.

+

If you would like to filter on <%= pageData.title -%>. You can specify include a query here. For more information, please check out writing queries here.

diff --git a/ApiDocs/views/main/pagination.ejs b/ApiReference/views/main/pagination.ejs similarity index 100% rename from ApiDocs/views/main/pagination.ejs rename to ApiReference/views/main/pagination.ejs diff --git a/ApiDocs/views/main/permissions.ejs b/ApiReference/views/main/permissions.ejs similarity index 100% rename from ApiDocs/views/main/permissions.ejs rename to ApiReference/views/main/permissions.ejs diff --git a/ApiReference/views/main/status.ejs b/ApiReference/views/main/status.ejs new file mode 100644 index 0000000000..5998005429 --- /dev/null +++ b/ApiReference/views/main/status.ejs @@ -0,0 +1,15 @@ +
+
+
+
+ +

200

+
+

+ Success +

+
+
+
+
+
\ No newline at end of file diff --git a/ApiDocs/views/pages/index.ejs b/ApiReference/views/pages/index.ejs similarity index 100% rename from ApiDocs/views/pages/index.ejs rename to ApiReference/views/pages/index.ejs diff --git a/ApiDocs/views/partials/code.ejs b/ApiReference/views/partials/code.ejs similarity index 100% rename from ApiDocs/views/partials/code.ejs rename to ApiReference/views/partials/code.ejs diff --git a/ApiDocs/views/partials/footer.ejs b/ApiReference/views/partials/footer.ejs similarity index 100% rename from ApiDocs/views/partials/footer.ejs rename to ApiReference/views/partials/footer.ejs diff --git a/ApiDocs/views/partials/head.ejs b/ApiReference/views/partials/head.ejs similarity index 100% rename from ApiDocs/views/partials/head.ejs rename to ApiReference/views/partials/head.ejs diff --git a/ApiDocs/views/partials/nav.ejs b/ApiReference/views/partials/nav.ejs similarity index 97% rename from ApiDocs/views/partials/nav.ejs rename to ApiReference/views/partials/nav.ejs index b594d34389..aa00bd6841 100644 --- a/ApiDocs/views/partials/nav.ejs +++ b/ApiReference/views/partials/nav.ejs @@ -210,7 +210,7 @@ @@ -246,7 +246,7 @@ <% for(var i=0; i
  • + href="/reference/<%= resources[i].path -%>"> <%= resources[i].name -%>
    • <% } %> diff --git a/ApiDocs/views/partials/sidenav.ejs b/ApiReference/views/partials/sidenav.ejs similarity index 100% rename from ApiDocs/views/partials/sidenav.ejs rename to ApiReference/views/partials/sidenav.ejs diff --git a/Home/views/footer.ejs b/Home/views/footer.ejs index 72eef5bc78..ff0cd60f25 100644 --- a/Home/views/footer.ejs +++ b/Home/views/footer.ejs @@ -91,7 +91,7 @@