mirror of
https://gitlab.com/openstapps/openstapps.git
synced 2026-01-03 20:12:51 +00:00
77 lines
2.4 KiB
TypeScript
77 lines
2.4 KiB
TypeScript
/*
|
|
* Copyright (C) 2019-2022 Open StApps
|
|
* This program is free software: you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the Free
|
|
* Software Foundation, version 3.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
|
* more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along with
|
|
* this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
import {StatusCodes} from 'http-status-codes';
|
|
import {SCAppConfiguration} from '../../config/app';
|
|
import {SCAuthorizationProvider, SCAuthorizationProviderType} from '../../config/authorization';
|
|
import {SCBackendConfiguration} from '../../config/backend';
|
|
import {SCInternalServerErrorResponse} from '../errors/internal-server-error';
|
|
import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed';
|
|
import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large';
|
|
import {SCSyntaxErrorResponse} from '../errors/syntax-error';
|
|
import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type';
|
|
import {SCValidationErrorResponse} from '../errors/validation';
|
|
import {SCAbstractRoute, SCRouteHttpVerbs} from '../route';
|
|
|
|
/**
|
|
* Index request
|
|
*
|
|
* @validatable
|
|
*/
|
|
export interface SCIndexRequest {}
|
|
|
|
/**
|
|
* A response to an index request
|
|
*
|
|
* @validatable
|
|
*/
|
|
export interface SCIndexResponse {
|
|
/**
|
|
* @see SCAppConfiguration
|
|
*/
|
|
app: SCAppConfiguration;
|
|
|
|
/**
|
|
* @see SCAuthorizationProvider
|
|
*/
|
|
auth: {[key in SCAuthorizationProviderType]?: SCAuthorizationProvider};
|
|
|
|
/**
|
|
* @see SCBackendConfiguration
|
|
*/
|
|
backend: SCBackendConfiguration;
|
|
}
|
|
|
|
/**
|
|
* Route to request meta information about the deployment
|
|
*/
|
|
export class SCIndexRoute extends SCAbstractRoute {
|
|
constructor() {
|
|
super();
|
|
this.errorNames = [
|
|
SCInternalServerErrorResponse,
|
|
SCMethodNotAllowedErrorResponse,
|
|
SCRequestBodyTooLargeErrorResponse,
|
|
SCSyntaxErrorResponse,
|
|
SCUnsupportedMediaTypeErrorResponse,
|
|
SCValidationErrorResponse,
|
|
];
|
|
this.method = SCRouteHttpVerbs.POST;
|
|
this.requestBodyName = 'SCIndexRequest';
|
|
this.responseBodyName = 'SCIndexResponse';
|
|
this.statusCodeSuccess = StatusCodes.OK;
|
|
this.urlPath = '/';
|
|
}
|
|
}
|