webhooks swagger api documentation (#289)

* webhooks swagger api documentation

---------

Co-authored-by: Ihor Duzhyk <[email protected]>

Author: Jackalx

scripts/build.js

@@ -21,4 +21,5 @@ cp('-R', 'spec/job_batches_v1', 'web_deploy/spec');
 cp('-R', 'spec/job_batches_v2', 'web_deploy/spec');
 cp('-R', 'spec/file_translation', 'web_deploy/spec');
 cp('-R', 'spec/glossary_v3', 'web_deploy/spec');
+cp('-R', 'spec/webhooks_api', 'web_deploy/spec');
 cp('-R', 'spec/api_common.yaml', 'web_deploy/spec');

scripts/deploy-branch.js

@@ -21,6 +21,7 @@ if (branch && branch !== 'gh-pages') {
   cp('-R', 'spec/job_batches_v1', specFolder);
   cp('-R', 'spec/job_batches_v2', specFolder);
   cp('-R', 'spec/glossary_v3', specFolder);
+  cp('-R', 'spec/webhooks_api', specFolder);
   cp('-R', 'spec/api_common.yaml', specFolder);
 
   exec('deploy-to-gh-pages --update .tmp');

spec/openapi.yaml

@@ -341,6 +341,10 @@ tags:
     description: |-
       The Workflow Assignment API handles workflow step assignments for non agency users.
 
+  - name: Webhooks
+    description: |-
+      The Webhooks API allows you to create and manage webhook subscriptions to receive real-time notifications about events in your Smartling projects. You can subscribe to various event types and receive HTTP callbacks when these events occur. See our [Events Catalog](https://help.smartling.com/hc/en-us/articles/39696685668251-Smartling-Webhooks-Overview) for a full list of events.
+
 paths:
   /auth-api/v2/authenticate:
     post:
@@ -9789,6 +9793,45 @@ paths:
 ## GlossaryV3 API END
 #
 
+#
+## Webhooks API
+#
+  /webhooks-api/v2/accounts/{accountUid}/subscriptions:
+    $ref: './spec/webhooks_api/webhooks_subscriptions.yaml#/x-paths/subscriptions'
+
+  /webhooks-api/v2/accounts/{accountUid}/subscriptions/{subscriptionUid}:
+    $ref: './spec/webhooks_api/webhooks_subscriptions.yaml#/x-paths/subscription_details'
+
+  /webhooks-api/v2/accounts/{accountUid}/available-event-types:
+    $ref: './spec/webhooks_api/webhooks_events.yaml#/x-paths/available_event_types'
+
+  /webhooks-api/v2/accounts/{accountUid}/subscriptions/{subscriptionUid}/patch:
+    $ref: './spec/webhooks_api/webhooks_subscriptions.yaml#/x-paths/subscription_patch'
+
+  /webhooks-api/v2/accounts/{accountUid}/subscriptions/{subscriptionUid}/secret:
+    $ref: './spec/webhooks_api/webhooks_subscriptions.yaml#/x-paths/subscription_secret'
+
+  /webhooks-api/v2/accounts/{accountUid}/subscriptions/{subscriptionUid}/statistics:
+    $ref: './spec/webhooks_api/webhooks_subscriptions.yaml#/x-paths/subscription_statistics'
+
+  /webhooks-api/v2/accounts/{accountUid}/subscriptions/{subscriptionUid}/enable:
+    $ref: './spec/webhooks_api/webhooks_subscriptions.yaml#/x-paths/subscription_enable'
+
+  /webhooks-api/v2/accounts/{accountUid}/subscriptions/{subscriptionUid}/disable:
+    $ref: './spec/webhooks_api/webhooks_subscriptions.yaml#/x-paths/subscription_disable'
+
+  /webhooks-api/v2/accounts/{accountUid}/subscriptions/{subscriptionUid}/events:
+    $ref: './spec/webhooks_api/webhooks_events.yaml#/x-paths/subscription_events'
+
+  /webhooks-api/v2/accounts/{accountUid}/subscriptions/{subscriptionUid}/events/{eventId}:
+    $ref: './spec/webhooks_api/webhooks_events.yaml#/x-paths/event_details'
+
+  /webhooks-api/v2/accounts/{accountUid}/subscriptions/{subscriptionUid}/events/{eventId}/attempts:
+    $ref: './spec/webhooks_api/webhooks_events.yaml#/x-paths/event_attempts'
+
+  /webhooks-api/v2/accounts/{accountUid}/subscriptions/{subscriptionUid}/events/{eventId}/send:
+    $ref: './spec/webhooks_api/webhooks_events.yaml#/x-paths/event_resend'
+
 
 components:
   requestBodies: