diff --git a/openapi/components/examples/enableHook-fail.yaml b/openapi/components/examples/enableHook-fail.yaml deleted file mode 100644 index b11686a..0000000 --- a/openapi/components/examples/enableHook-fail.yaml +++ /dev/null @@ -1,37 +0,0 @@ -fail: - value: |- - - FAILED - checksumError - You did not pass the checksum security check - - - - FAILED - missingParamHookID - You must specify a hookID in the parameters. - - - - FAILED - invalidParamHookID - You must specify a valid hookID in the parameters. - - - - FAILED - enableHookError - An error happened while enabling your hook. Please contact the system's administrators. - - - - FAILED - enableMissingHook - The hook informed was not found or the shared secret didn't match the hook's. - - - - FAILED - enableWrongSecret - The secret informed is not able to enable this hook. - \ No newline at end of file diff --git a/openapi/components/examples/enableHook/enableHook-enableError.yaml b/openapi/components/examples/enableHook/enableHook-enableError.yaml new file mode 100644 index 0000000..43a002b --- /dev/null +++ b/openapi/components/examples/enableHook/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/enableHook-fail.yaml b/openapi/components/examples/enableHook/enableHook-fail.yaml new file mode 100644 index 0000000..5aeccbb --- /dev/null +++ b/openapi/components/examples/enableHook/enableHook-fail.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/enableHook-hookNotFoundError.yaml b/openapi/components/examples/enableHook/enableHook-hookNotFoundError.yaml new file mode 100644 index 0000000..61c6535 --- /dev/null +++ b/openapi/components/examples/enableHook/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/enableHook-invalidHookIDError.yaml b/openapi/components/examples/enableHook/enableHook-invalidHookIDError.yaml new file mode 100644 index 0000000..6978e8a --- /dev/null +++ b/openapi/components/examples/enableHook/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/enableHook-missingParamError.yaml b/openapi/components/examples/enableHook/enableHook-missingParamError.yaml new file mode 100644 index 0000000..b22e0bb --- /dev/null +++ b/openapi/components/examples/enableHook/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/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/paths/enable.yaml b/openapi/paths/enable.yaml index 3869b9e..b6ae330 100644 --- a/openapi/paths/enable.yaml +++ b/openapi/paths/enable.yaml @@ -17,4 +17,44 @@ get: examples: $ref: '../components/examples/enableHook/success.yaml' schema: - $ref: '../components/schemas/responses/enableHook.yaml' \ No newline at end of file + $ref: '../components/schemas/responses/enableHook.yaml' + '204': + description: Hook Not Found + content: + application/xml: + examples: + $ref: '../components/examples/enableHook/enableHook-hookNotFoundError.yaml' + schema: + $ref: '../components/schemas/responses/enableHookError.yaml' + '400': + description: Invalid Hook ID + content: + application/xml: + examples: + $ref: '../components/examples/enableHook/enableHook-invalidHookIDError.yaml' + schema: + $ref: '../components/schemas/responses/enableHookError.yaml' + '401': + description: Checksum test failed + content: + application/xml: + examples: + $ref: '../components/examples/enableHook/enableHook-fail.yaml' + schema: + $ref: '../components/schemas/responses/enableHookError.yaml' + '422': + description: Missing Hook ID + content: + application/xml: + examples: + $ref: '../components/examples/enableHook/enableHook-missingParamError.yaml' + schema: + $ref: '../components/schemas/responses/enableHookError.yaml' + '500': + description: Couldn't enable hook + content: + application/xml: + examples: + $ref: '../components/examples/enableHook/enableHook-enableError.yaml' + schema: + $ref: '../components/schemas/responses/enableHookError.yaml' \ No newline at end of file