Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2026-01-19 16:13:06 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add blank line before @param

Browse Source
This commit is contained in:
Wieland Schöbl
2019-04-02 11:52:48 +02:00
parent 81887315f8
commit c4e30c5fdd
3 changed files with 58 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/core/protocol/routes/plugin/PluginRegisterRequest.ts
View File

@@ -16,7 +16,10 @@ import {Schema} from 'jsonschema';
import {SCAbstractRoute, SCRouteHttpVerbs} from '../../../Route';
import {
SCInternalServerErrorResponse,
SCMethodNotAllowedErrorResponse, SCPluginRegisteringFailedErrorResponse, SCPluginRouteAlreadyRegisteredErrorResponse,
SCMethodNotAllowedErrorResponse, SCParametersNotAcceptable,
SCPluginAlreadyRegisteredErrorResponse,
SCPluginRegisteringFailedErrorResponse,
SCPluginRouteAlreadyRegisteredErrorResponse,
SCRequestBodyTooLargeErrorResponse,
SCSyntaxErrorResponse,
} from '../../errors/ErrorResponse';
@@ -29,17 +32,17 @@ import {
export type SCPluginRegisterRequest = AddPlugin | RemovePlugin;
interface AddPlugin {
/**
* The desired action, so whether the plugin should be added or removed.
* The desired action, so whether the plugin should be added or removed
*/
action: 'add';
/**
* The address of the plugin.
* The address of the plugin
*/
address: string;
/**
* The name of the plugin.
* The name of the plugin
* Just for debugging purposes, to more easily identify conflicts.
*/
name: string;
@@ -55,13 +58,13 @@ interface AddPlugin {
pluginResponseSchema: Schema;
/**
* the desired route, for example /feedback.
* The desired route, for example /feedback.
*/
route: string;
}
interface RemovePlugin {
/**
* The desired action, so whether the plugin should be added or removed.
* The desired action, so whether the plugin should be added or removed
*/
action: 'remove';
@@ -72,7 +75,7 @@ interface RemovePlugin {
}
/**
* Route to register Plugins
* Route to register plugins
*/
export class SCPluginRegisterRoute extends SCAbstractRoute {
constructor() {
@@ -80,6 +83,9 @@ export class SCPluginRegisterRoute extends SCAbstractRoute {
this.errorNames = [
SCInternalServerErrorResponse,
SCMethodNotAllowedErrorResponse,
SCParametersNotAcceptable,
SCPluginAlreadyRegisteredErrorResponse,
SCPluginRouteAlreadyRegisteredErrorResponse,
SCPluginRegisteringFailedErrorResponse,
SCPluginRouteAlreadyRegisteredErrorResponse,
SCRequestBodyTooLargeErrorResponse,