diff --git a/openapi/components/examples/enableHook/checksumError.yaml b/openapi/components/examples/enableHook/checksumError.yaml new file mode 100644 index 0000000..5aeccbb --- /dev/null +++ b/openapi/components/examples/enableHook/checksumError.yaml @@ -0,0 +1,7 @@ +fail: + value: |- + + FAILED + checksumError + You did not pass the checksum security check + \ No newline at end of file diff --git a/openapi/components/examples/enableHook/enableError.yaml b/openapi/components/examples/enableHook/enableError.yaml new file mode 100644 index 0000000..43a002b --- /dev/null +++ b/openapi/components/examples/enableHook/enableError.yaml @@ -0,0 +1,7 @@ +fail: + value: |- + + FAILED + enableHookError + An error happened while enabling your hook. Please contact the system's administrators. + \ No newline at end of file diff --git a/openapi/components/examples/enableHook/hookNotFoundError.yaml b/openapi/components/examples/enableHook/hookNotFoundError.yaml new file mode 100644 index 0000000..61c6535 --- /dev/null +++ b/openapi/components/examples/enableHook/hookNotFoundError.yaml @@ -0,0 +1,7 @@ +fail: + value: |- + + FAILED + enableMissingHook + The hook informed was not found or the shared secret didn't match the hook's. + \ No newline at end of file diff --git a/openapi/components/examples/enableHook/invalidHookIDError.yaml b/openapi/components/examples/enableHook/invalidHookIDError.yaml new file mode 100644 index 0000000..6978e8a --- /dev/null +++ b/openapi/components/examples/enableHook/invalidHookIDError.yaml @@ -0,0 +1,7 @@ +fail: + value: |- + + FAILED + invalidParamHookID + You must specify a valid hookID in the parameters. + \ No newline at end of file diff --git a/openapi/components/examples/enableHook/missingParamError.yaml b/openapi/components/examples/enableHook/missingParamError.yaml new file mode 100644 index 0000000..b22e0bb --- /dev/null +++ b/openapi/components/examples/enableHook/missingParamError.yaml @@ -0,0 +1,7 @@ +fail: + value: |- + + FAILED + missingParamHookID + You must specify a hookID in the parameters. + \ No newline at end of file diff --git a/openapi/components/examples/enableHook/success.yaml b/openapi/components/examples/enableHook/success.yaml new file mode 100644 index 0000000..6083b37 --- /dev/null +++ b/openapi/components/examples/enableHook/success.yaml @@ -0,0 +1,6 @@ +success: + value: |- + + SUCCESS + true + \ No newline at end of file diff --git a/openapi/components/parameters/sharedSecretGUID.yaml b/openapi/components/parameters/sharedSecretGUID.yaml new file mode 100644 index 0000000..2a57c11 --- /dev/null +++ b/openapi/components/parameters/sharedSecretGUID.yaml @@ -0,0 +1,5 @@ +name: sharedSecretGUID +in: query +description: The GUID used to created the secret. +schema: + type: string \ No newline at end of file diff --git a/openapi/components/schemas/responses/enableHook.yaml b/openapi/components/schemas/responses/enableHook.yaml new file mode 100644 index 0000000..7935ece --- /dev/null +++ b/openapi/components/schemas/responses/enableHook.yaml @@ -0,0 +1,14 @@ +type: object +required: + - response +properties: + response: + type: object + required: + - returncode + - hookID + properties: + returncode: + type: string + hookID: + type: string \ No newline at end of file diff --git a/openapi/components/schemas/responses/enableHookError.yaml b/openapi/components/schemas/responses/enableHookError.yaml new file mode 100644 index 0000000..90aa262 --- /dev/null +++ b/openapi/components/schemas/responses/enableHookError.yaml @@ -0,0 +1,15 @@ +type: object +required: + - response + - messageKey + - message +properties: + response: + type: object + properties: + returncode: + type: string + messageKey: + type: string + message: + type: string \ No newline at end of file diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml index fc9ec2c..6880411 100644 --- a/openapi/openapi.yaml +++ b/openapi/openapi.yaml @@ -58,6 +58,8 @@ paths: $ref: './paths/list.yaml' /hooks/destroy: $ref: './paths/destroy.yaml' + /hooks/enable: + $ref: './paths/enable.yaml' /getDefaultConfigXML: $ref: './paths/getDefaultConfigXML.yaml' diff --git a/openapi/paths/enable.yaml b/openapi/paths/enable.yaml new file mode 100644 index 0000000..3a568d0 --- /dev/null +++ b/openapi/paths/enable.yaml @@ -0,0 +1,60 @@ +get: + summary: enable + operationId: hooks-enable + description: Enables a Hook to receive meetings events. + tags: + - hooks + parameters: + - $ref: '../components/parameters/hookID.yaml' + required: true + - $ref: '../components/parameters/checksum.yaml' + + responses: + '200': + description: Successful operation + content: + application/xml: + examples: + $ref: '../components/examples/enableHook/success.yaml' + schema: + $ref: '../components/schemas/responses/enableHook.yaml' + '400': + description: Missing Hook ID + content: + application/xml: + examples: + $ref: '../components/examples/enableHook/missingParamError.yaml' + schema: + $ref: '../components/schemas/responses/enableHookError.yaml' + '401': + description: Checksum check failed + content: + application/xml: + examples: + $ref: '../components/examples/enableHook/checksumError.yaml' + schema: + $ref: '../components/schemas/responses/enableHookError.yaml' + '404': + description: Hook Not Found + content: + application/xml: + examples: + $ref: '../components/examples/enableHook/hookNotFoundError.yaml' + schema: + $ref: '../components/schemas/responses/enableHookError.yaml' + '422': + description: Invalid Hook ID + content: + application/xml: + examples: + $ref: '../components/examples/enableHook/invalidHookIDError.yaml' + schema: + $ref: '../components/schemas/responses/enableHookError.yaml' + '500': + description: Couldn't enable hook + content: + application/xml: + examples: + $ref: '../components/examples/enableHook/enableError.yaml' + schema: + $ref: '../components/schemas/responses/enableHookError.yaml' \ No newline at end of file