🗃️Endpoints - Les sujets

Lister les sujets d'un forum

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

200

Topics returned successfully

application/json

400

Malformed payload

get

HTTPcURLJavaScriptPython

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

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

Récupérer un sujet

get

Get a topic

Paramètres de chemin

forumIdstringRequis

The id of the forum

topicIdstringRequis

The id of the topic

Réponses

200

Topic found and returned successfully

application/json

400

Malformed payload

404

Topic not found

get

HTTPcURLJavaScriptPython

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

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

Modifier un sujet

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

200

Topic successfully updated

application/json

400

Malformed payload

404

Topic not found

put

HTTPcURLJavaScriptPython

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"
}

Supprimer un sujet

delete

Delete a topic

Paramètres de chemin

forumIdstringRequis

The id of the forum

topicIdstringRequis

The id of the topic

Réponses

204

Topic successfully deleted

400

Malformed payload

404

Topic not found

delete

HTTPcURLJavaScriptPython

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

Aucun contenu

Créer un sujet

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

201

Topic has been successfully created

application/json

400

Malformed payload

post

HTTPcURLJavaScriptPython

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"
}

Créer plusieurs sujets

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

201

Topics has been successfully created

application/json

400

Malformed payload

413

Payload is too large

post

HTTPcURLJavaScriptPython

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"
    }
  ]
}