rename api ref
@ -1 +0,0 @@
|
|||||||
PORT=1445
|
|
@ -15,12 +15,13 @@ import AuthenticationServiceHandler from './Service/Authentication';
|
|||||||
import PageNotFoundServiceHandler from './Service/PageNotFound';
|
import PageNotFoundServiceHandler from './Service/PageNotFound';
|
||||||
import ModelServiceHandler from './Service/Model';
|
import ModelServiceHandler from './Service/Model';
|
||||||
import PaginationServiceHandler from './Service/Pagination';
|
import PaginationServiceHandler from './Service/Pagination';
|
||||||
|
import StatusServiceHandler from './Service/Status';
|
||||||
import Dictionary from 'Common/Types/Dictionary';
|
import Dictionary from 'Common/Types/Dictionary';
|
||||||
|
|
||||||
const ResourceDictionary: Dictionary<ModelDocumentation> =
|
const ResourceDictionary: Dictionary<ModelDocumentation> =
|
||||||
ResourceUtil.getReosurceDictionaryByPath();
|
ResourceUtil.getReosurceDictionaryByPath();
|
||||||
|
|
||||||
const APP_NAME: string = 'docs';
|
const APP_NAME: string = 'reference';
|
||||||
|
|
||||||
const app: ExpressApplication = Express.getExpressApp();
|
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(ExpressStatic(path.join(__dirname, 'public'), { maxAge: 2592000 }));
|
||||||
|
|
||||||
app.use(
|
app.use(
|
||||||
'/docs',
|
'/reference',
|
||||||
ExpressStatic(path.join(__dirname, 'public'), { maxAge: 2592000 })
|
ExpressStatic(path.join(__dirname, 'public'), { maxAge: 2592000 })
|
||||||
);
|
);
|
||||||
|
|
||||||
// Index page
|
// Index page
|
||||||
app.get(['/docs'], (_req: ExpressRequest, res: ExpressResponse) => {
|
app.get(['/reference'], (_req: ExpressRequest, res: ExpressResponse) => {
|
||||||
return res.redirect('/docs/introduction');
|
return res.redirect('/reference/introduction');
|
||||||
});
|
});
|
||||||
|
|
||||||
app.get(
|
app.get(
|
||||||
['/docs/page-not-found'],
|
['/reference/page-not-found'],
|
||||||
(req: ExpressRequest, res: ExpressResponse) => {
|
(req: ExpressRequest, res: ExpressResponse) => {
|
||||||
return PageNotFoundServiceHandler.executeResponse(req, res);
|
return PageNotFoundServiceHandler.executeResponse(req, res);
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
// All Pages
|
// 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'];
|
const page: string | undefined = req.params['page'];
|
||||||
|
|
||||||
if (!page) {
|
if (!page) {
|
||||||
@ -69,6 +70,8 @@ app.get(['/docs/:page'], (req: ExpressRequest, res: ExpressResponse) => {
|
|||||||
return ErrorServiceHandler.executeResponse(req, res);
|
return ErrorServiceHandler.executeResponse(req, res);
|
||||||
} else if (req.params['page'] === 'introduction') {
|
} else if (req.params['page'] === 'introduction') {
|
||||||
return IntroductionServiceHandler.executeResponse(req, res);
|
return IntroductionServiceHandler.executeResponse(req, res);
|
||||||
|
} else if (req.params['page'] === 'status') {
|
||||||
|
return StatusServiceHandler.executeResponse(req, res);
|
||||||
} else if (currentResource) {
|
} else if (currentResource) {
|
||||||
return ModelServiceHandler.executeResponse(req, res);
|
return ModelServiceHandler.executeResponse(req, res);
|
||||||
}
|
}
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
[![Build Status](https://travis-ci.org/OneUptime/ApiDocs.svg?branch=master)](https://travis-ci.org/OneUptime/ApiDocs)
|
[![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
|
# Contribute
|
||||||
|
|
20
ApiReference/Service/Status.ts
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
import { ExpressRequest, ExpressResponse } from 'CommonServer/Utils/Express';
|
||||||
|
import ResourceUtil, { ModelDocumentation } from '../Utils/Resources';
|
||||||
|
|
||||||
|
const Resources: Array<ModelDocumentation> = ResourceUtil.getResources();
|
||||||
|
|
||||||
|
export default class ServiceHandler {
|
||||||
|
public static async executeResponse(
|
||||||
|
_req: ExpressRequest,
|
||||||
|
res: ExpressResponse
|
||||||
|
): Promise<void> {
|
||||||
|
res.status(200);
|
||||||
|
return res.render('pages/index', {
|
||||||
|
page: 'status',
|
||||||
|
pageTitle: 'Status',
|
||||||
|
pageDescription: "200 - Success",
|
||||||
|
resources: Resources,
|
||||||
|
pageData: {},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
Before Width: | Height: | Size: 5.1 KiB After Width: | Height: | Size: 5.1 KiB |
Before Width: | Height: | Size: 1.4 KiB After Width: | Height: | Size: 1.4 KiB |
Before Width: | Height: | Size: 5.0 KiB After Width: | Height: | Size: 5.0 KiB |
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 2.1 KiB After Width: | Height: | Size: 2.1 KiB |
Before Width: | Height: | Size: 740 B After Width: | Height: | Size: 740 B |
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
Before Width: | Height: | Size: 3.2 KiB After Width: | Height: | Size: 3.2 KiB |
Before Width: | Height: | Size: 3.5 KiB After Width: | Height: | Size: 3.5 KiB |
Before Width: | Height: | Size: 321 B After Width: | Height: | Size: 321 B |
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
Before Width: | Height: | Size: 649 B After Width: | Height: | Size: 649 B |
Before Width: | Height: | Size: 1.7 KiB After Width: | Height: | Size: 1.7 KiB |
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.3 KiB |
Before Width: | Height: | Size: 764 B After Width: | Height: | Size: 764 B |
Before Width: | Height: | Size: 3.2 KiB After Width: | Height: | Size: 3.2 KiB |
Before Width: | Height: | Size: 870 B After Width: | Height: | Size: 870 B |
Before Width: | Height: | Size: 7.5 KiB After Width: | Height: | Size: 7.5 KiB |
Before Width: | Height: | Size: 1.0 KiB After Width: | Height: | Size: 1.0 KiB |
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 1.6 KiB |
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 1.6 KiB |
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 1.9 KiB |
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
Before Width: | Height: | Size: 2.0 KiB After Width: | Height: | Size: 2.0 KiB |
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 1.6 KiB |
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.3 KiB |
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
Before Width: | Height: | Size: 1.0 KiB After Width: | Height: | Size: 1.0 KiB |
Before Width: | Height: | Size: 902 B After Width: | Height: | Size: 902 B |
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 924 B After Width: | Height: | Size: 924 B |
Before Width: | Height: | Size: 1.2 KiB After Width: | Height: | Size: 1.2 KiB |
Before Width: | Height: | Size: 1.0 KiB After Width: | Height: | Size: 1.0 KiB |
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |
Before Width: | Height: | Size: 1.0 KiB After Width: | Height: | Size: 1.0 KiB |
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.3 KiB |
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
Before Width: | Height: | Size: 804 B After Width: | Height: | Size: 804 B |
Before Width: | Height: | Size: 2.4 KiB After Width: | Height: | Size: 2.4 KiB |
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 1.9 KiB |
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 1.9 KiB |
Before Width: | Height: | Size: 2.0 KiB After Width: | Height: | Size: 2.0 KiB |
Before Width: | Height: | Size: 3.4 KiB After Width: | Height: | Size: 3.4 KiB |
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
Before Width: | Height: | Size: 1.7 KiB After Width: | Height: | Size: 1.7 KiB |
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
Before Width: | Height: | Size: 5.0 KiB After Width: | Height: | Size: 5.0 KiB |
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 82 KiB |
Before Width: | Height: | Size: 152 KiB After Width: | Height: | Size: 152 KiB |
Before Width: | Height: | Size: 3.5 KiB After Width: | Height: | Size: 3.5 KiB |
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |