fix: Help center api doc (#7189)

swagger/definitions/resource/article.yml

@@ -0,0 +1,33 @@
+type: object
+properties:
+  id:
+    type: integer
+  content:
+    type: string
+    description: The text content.
+  meta:
+    type: object
+  position:
+    type: integer
+  status:
+    type: integer
+    enum: ['draft', 'published', 'archived']
+  title:
+    type: string
+  slug:
+    type: string
+  views:
+    type: integer
+  portal_id:
+    type: integer
+  account_id:
+    type: integer
+  author_id:
+    type: integer
+  category_id:
+    type: integer
+  folder_id:
+    type: integer
+  associated_article_id:
+    type: integer
+    description: To associate similar articles to each other, e.g to provide the link for the reference.

swagger/definitions/resource/category.yml

@@ -0,0 +1,25 @@
+type: object
+properties:
+  id:
+    type: integer
+  description:
+    type: string
+    description: The text content.
+  locale:
+    type: string
+  name:
+    type: string
+  slug:
+    type: string
+  position:
+    type: integer
+  portal_id:
+    type: integer
+  account_id:
+    type: integer
+  associated_category_id:
+    type: integer
+    description: To associate similar categories to each other, e.g same category of product documentation in different languages
+  parent_category_id:
+    type: integer
+    description: To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.

swagger/definitions/resource/portal.yml

@@ -0,0 +1,34 @@
+type: object
+properties:
+  id:
+    type: integer
+  archived:
+    type: boolean
+  color:
+    type: string
+  config:
+    type: object
+    description: Save information about locales, allowed_locales and default portal/help-center locale
+  custom_domain:
+    type: string
+  header_text:
+    type: string
+    description: The text content.
+  homepage_link:
+    type: string
+  name:
+    type: string
+  slug:
+    type: string
+  page_title:
+    type: string
+  account_id:
+    type: integer
+  categories:
+    type: array
+    items:
+      $ref: '#/definitions/category'
+  articles:
+    type: array
+    items:
+      $ref: '#/definitions/article'