Endpoints - Topics

PrécédentEndpoints - Forums SuivantEndpoints - Groups

Dernière mise à jour il y a 4 mois

Cet article vous a-t-il été utile ?

get

Get a topic

Paramètres de chemin

forumIdstringRequis

The id of the forum

topicIdstringRequis

The id of the topic

Réponses

get

GET /v1/forums/{forumId}/topics/{topicId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

{
  "id": "text",
  "name": "text"
}

delete

Delete a topic

Paramètres de chemin

forumIdstringRequis

The id of the forum

topicIdstringRequis

The id of the topic

Réponses

delete

DELETE /v1/forums/{forumId}/topics/{topicId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

Aucun contenu

get

List topics

Paramètres de chemin

forumIdstringRequis

The id of the forum

Paramètres de requête

pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

name[eq]stringOptionnel

Search Topic with a specified name

name[contains]stringOptionnel

Search Topic that contains this value in his name

Réponses

get

GET /v1/forums/{forumId}/topics HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

{
  "items": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "total": 1
}

put

Update a topic

Paramètres de chemin

forumIdstringRequis

The id of the forum

topicIdstringRequis

The id of the topic

Corps

namestringOptionnel

Name of the topic

contentstringOptionnel

Content of the topic

Réponses

put

PUT /v1/forums/{forumId}/topics/{topicId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "name": "text",
  "content": "text"
}

{
  "id": "text",
  "name": "text"
}

post

Create a topic

Paramètres de chemin

forumIdstringRequis

The id of the forum

Corps

namestringRequis

Name of the topic

contentstringOptionnel

Content of the topic (in Markdown)

Réponses

post

POST /v1/forums/{forumId}/topics HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "name": "text",
  "content": "text"
}

{
  "id": "text",
  "name": "text"
}

post

Create multiple topics

Paramètres de chemin

forumIdstringRequis

ID of the forum

Corps

namestringRequis

Name of the topic

contentstringOptionnel

Content of the topic (in Markdown)

Réponses

post

POST /v1/forums/{forumId}/topics~bulkCreate HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 34

[
  {
    "name": "text",
    "content": "text"
  }
]

{
  "created": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "description": {},
      "privacy": "Private",
      "autoJoin": true,
      "showMembers": true
    }
  ],
  "failed": [
    {
      "name": "text",
      "description": "text",
      "emoji": "text",
      "autoJoin": true,
      "showMembers": true,
      "privacy": "Private"
    }
  ]
}