fix: Help center api doc (#7189)

swagger/paths/application/article/create.yml

@@ -0,0 +1,20 @@
+tags:
+  - Help Center
+operationId: add-new-article-to-account
+summary: Add a new article
+description: Add a new article to portal
+security:
+  - userApiKey: []
+parameters:
+  - name: data
+    in: body
+    required: true
+    schema:
+      $ref: '#/definitions/article_create_update_payload'
+responses:
+  '200':
+    description: Success
+    schema:
+      $ref: '#/definitions/article'
+  '403':
+    description: Access denied

swagger/paths/application/category/create.yml

@@ -0,0 +1,20 @@
+tags:
+  - Help Center
+operationId: add-new-category-to-account
+summary: Add a new category
+description: Add a new category to portal
+security:
+  - userApiKey: []
+parameters:
+  - name: data
+    in: body
+    required: true
+    schema:
+      $ref: '#/definitions/category_create_update_payload'
+responses:
+  '200':
+    description: Success
+    schema:
+      $ref: '#/definitions/category'
+  '403':
+    description: Access denied

swagger/paths/application/portal/create.yml

@@ -0,0 +1,20 @@
+tags:
+  - Help Center
+operationId: add-new-portal-to-account
+summary: Add a new portal
+description: Add a new portal to account
+security:
+  - userApiKey: []
+parameters:
+  - name: data
+    in: body
+    required: true
+    schema:
+      $ref: '#/definitions/portal_create_update_payload'
+responses:
+  '200':
+    description: Success
+    schema:
+      $ref: '#/definitions/portal'
+  '403':
+    description: Access denied

swagger/paths/application/portal/index.yml

@@ -0,0 +1,19 @@
+tags:
+  - Help Center
+operationId: get-portal
+summary: List all portals in an account
+parameters:
+  - $ref: '#/parameters/account_id'
+description: Get details of portals in an Account
+security:
+  - userApiKey: []
+responses:
+  '200':
+    description: Success
+    schema:
+      type: array
+      description: Array of all portals
+      items:
+        $ref: '#/definitions/portal'
+  '403':
+    description: Access denied

swagger/paths/application/portal/update.yml

@@ -0,0 +1,20 @@
+tags:
+  - Help Center
+operationId: update-new-portal-to-account
+summary: update a new portal
+description: update a new portal to account
+security:
+  - userApiKey: []
+parameters:
+  - name: data
+    in: body
+    required: true
+    schema:
+      $ref: '#/definitions/portal_create_update_payload'
+responses:
+  '200':
+    description: Success
+    schema:
+      $ref: '#/definitions/portal'
+  '403':
+    description: Access denied

swagger/paths/index.yml

@@ -245,6 +245,35 @@
     $ref: ./application/automation_rule/delete.yml
 
 
+# Help Center
+/api/v1/accounts/{account_id}/portals:
+  parameters:
+    - $ref: '#/parameters/account_id'
+  post:
+    $ref: ./application/portal/create.yml
+  get:
+    $ref: ./application/portal/index.yml
+  patch:
+    $ref: ./application/portal/update.yml
+
+
+# Help Center category
+/api/v1/accounts/{account_id}/portals/{portal_id}/categories:
+  parameters:
+    - $ref: '#/parameters/account_id'
+    - $ref: '#/parameters/portal_id'
+  post:
+    $ref: ./application/category/create.yml
+
+# Help Center article
+/api/v1/accounts/{account_id}/portals/{portal_id}/articles:
+  parameters:
+    - $ref: '#/parameters/account_id'
+    - $ref: '#/parameters/portal_id'
+  post:
+    $ref: ./application/article/create.yml
+
+
 # Conversations
 /api/v1/accounts/{account_id}/conversations/meta:
   $ref: ./application/conversation/meta.yml