fix: Help center api doc (#7189)
This commit is contained in:
@@ -0,0 +1,34 @@
|
||||
type: object
|
||||
properties:
|
||||
content:
|
||||
type: string
|
||||
description: The text content.
|
||||
meta:
|
||||
type: object
|
||||
description: Use for search
|
||||
example: { tags: ['article_name'], title: 'article title', description: 'article description' }
|
||||
position:
|
||||
type: integer
|
||||
description: article position in category
|
||||
status:
|
||||
type: integer
|
||||
example: ['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.
|
||||
@@ -0,0 +1,28 @@
|
||||
type: object
|
||||
properties:
|
||||
description:
|
||||
type: string
|
||||
description: Category description
|
||||
locale:
|
||||
type: string
|
||||
description: Category locale
|
||||
example: en/es
|
||||
name:
|
||||
type: string
|
||||
description: Category name
|
||||
slug:
|
||||
type: string
|
||||
description: Category slug
|
||||
position:
|
||||
type: integer
|
||||
description: Category position in the portal list to sort
|
||||
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.
|
||||
@@ -0,0 +1,36 @@
|
||||
type: object
|
||||
properties:
|
||||
archived:
|
||||
type: boolean
|
||||
description: Status to check if portal is live
|
||||
color:
|
||||
type: string
|
||||
description: Header color for help-center
|
||||
example: add color HEX string, "#fffff"
|
||||
config:
|
||||
type: object
|
||||
description: Configuration about supporting locales
|
||||
example: { allowed_locales: ['en', 'es'], default_locale: 'en' }
|
||||
custom_domain:
|
||||
type: string
|
||||
description: Custom domain to display help center.
|
||||
example: https://chatwoot.help/.
|
||||
header_text:
|
||||
type: string
|
||||
description: Help center header
|
||||
example: Handbook
|
||||
homepage_link:
|
||||
type: string
|
||||
description: link to main dashboard
|
||||
example: https://www.chatwoot.com/
|
||||
name:
|
||||
type: string
|
||||
description: Name for the portal
|
||||
slug:
|
||||
type: string
|
||||
description: Slug for the portal to display in link
|
||||
page_title:
|
||||
type: string
|
||||
description: Page title for the portal
|
||||
account_id:
|
||||
type: integer
|
||||
Reference in New Issue
Block a user