mirror of
https://gitlab.com/openstapps/openstapps.git
synced 2026-10-12 20:42:56 +00:00
65 lines
2.3 KiB
TypeScript
65 lines
2.3 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 {SCThings} from '../../meta.js';
|
|
import {SCInternalServerErrorResponse} from '../errors/internal-server-error.js';
|
|
import {SCMethodNotAllowedErrorResponse} from '../errors/method-not-allowed.js';
|
|
import {SCNotFoundErrorResponse} from '../errors/not-found.js';
|
|
import {SCRequestBodyTooLargeErrorResponse} from '../errors/request-body-too-large.js';
|
|
import {SCSyntaxErrorResponse} from '../errors/syntax-error.js';
|
|
import {SCUnsupportedMediaTypeErrorResponse} from '../errors/unsupported-media-type.js';
|
|
import {SCValidationErrorResponse} from '../errors/validation.js';
|
|
import {SCAbstractRoute, SCRouteHttpVerbs} from '../route.js';
|
|
|
|
/**
|
|
* Request to update an existing thing
|
|
* @validatable
|
|
*/
|
|
export type SCThingUpdateRequest = SCThings;
|
|
|
|
/**
|
|
* Response for an entity update request
|
|
* @validatable
|
|
*/
|
|
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
|
export interface SCThingUpdateResponse {}
|
|
|
|
/**
|
|
* Route for updating existing things
|
|
*/
|
|
export class SCThingUpdateRoute extends SCAbstractRoute {
|
|
constructor() {
|
|
super();
|
|
this.errorNames = [
|
|
SCInternalServerErrorResponse,
|
|
SCMethodNotAllowedErrorResponse,
|
|
SCNotFoundErrorResponse,
|
|
SCRequestBodyTooLargeErrorResponse,
|
|
SCSyntaxErrorResponse,
|
|
SCUnsupportedMediaTypeErrorResponse,
|
|
SCValidationErrorResponse,
|
|
];
|
|
this.method = SCRouteHttpVerbs.PUT;
|
|
this.obligatoryParameters = {
|
|
TYPE: 'SCThingType',
|
|
UID: 'SCUuid',
|
|
};
|
|
this.requestBodyName = 'SCThingUpdateRequest';
|
|
this.responseBodyName = 'SCThingUpdateResponse';
|
|
this.statusCodeSuccess = StatusCodes.OK;
|
|
this.urlPath = '/:TYPE/:UID';
|
|
}
|
|
}
|