v1

latestOpenAPI 3.1.02026-07-24188215268.7 KB
topics and comments - resource

Create a new topic

This API allows users to initiate a new topic for discussions and comments. To create a topic, the user must have access to the resource.

post/topics

Request body

defaultTopicboolean

True if this is the default topic for the specified resource. There should only be 1 topic with this field set per resource. Must be provided while creating a topic only.

titlestring
topicIdstring

Short friendly form of a topic id that uniquely identifies the topic within a resource.

topicSlugstring

Short friendly form of a topic title.

topicUuidstring uuid

Unique id of the topic generated while create new one. Returned for reference but must be provided through URL only.

visibility'DISCOVERABLE' | 'OPEN' | 'PRIVATE'

Topic visibility. The field is required.

Response

default response

defaultTopicboolean

True if this is the default topic for the specified resource. There should only be 1 topic with this field set per resource. Must be provided while creating a topic only.

titlestring
topicIdstring

Short friendly form of a topic id that uniquely identifies the topic within a resource.

topicSlugstring

Short friendly form of a topic title.

topicUuidstring uuid

Unique id of the topic generated while create new one. Returned for reference but must be provided through URL only.

visibility'DISCOVERABLE' | 'OPEN' | 'PRIVATE'

Topic visibility. The field is required.