Discuss Kit icon

Discuss Kit

Consume Discuss Kit API

Actions77

Documentation → Create

AI-generated

Overview

This node operation creates a new documentation content item within the Discuss Kit platform. It allows users to specify various attributes such as title, content (in JSON string format), board ID, labels, assignees, language, slug, parent ID, and display order. The node sends these details to the Discuss Kit API to create and publish the documentation content. This operation is useful for automating the creation of structured documentation content in a collaborative environment, such as internal knowledge bases or public documentation sites.

Use Case Examples

  1. Creating a new documentation page with a specific title, content, and language for an internal knowledge base.
  2. Adding a documentation entry with labels and assignees to organize and assign responsibility within a team.
  3. Publishing a hierarchical documentation structure by specifying parent ID and display order for better content organization.

Properties

Name Meaning
Title Title of the documentation content, required for creation and update operations.
Content Content of the documentation in JSON string format, required for creation and update operations.
Board ID of the board to which this documentation belongs, used to categorize the content.
Labels Comma-separated labels for the documentation to help with categorization and search.
Assignees Comma-separated DIDs of assignees responsible for the documentation content.
Language Language of the documentation content, default is 'en'.
Slug Slug of the documentation content used in URLs or identifiers.
Parent ID ID of the parent documentation content to create a hierarchical structure.
Display Order Numeric value to determine the display order of the documentation content.

Output

JSON

  • id - Unique identifier of the created documentation content.
  • title - Title of the created documentation content.
  • content - Content of the created documentation content in JSON format.
  • boardId - Board ID associated with the documentation content.
  • labels - Labels assigned to the documentation content.
  • assignees - Assignees responsible for the documentation content.
  • locale - Language locale of the documentation content.
  • slug - Slug used for the documentation content.
  • parentId - Parent ID if the documentation content is part of a hierarchy.
  • order - Display order of the documentation content.

Dependencies

  • Discuss Kit API

Troubleshooting

  • Ensure all required fields like title and content are provided; missing these will cause errors.
  • Verify that the board ID exists and is accessible; invalid board IDs will cause API request failures.
  • Check the format of labels and assignees; they should be comma-separated strings.
  • If the API request fails, check network connectivity and API authentication credentials.
  • Errors related to slug uniqueness or format may occur; ensure the slug is unique and URL-friendly.

Links

Discussion