🗃️Endpoints - Les sujets

Lister les sujets d'un forum

get

List topics

Path parameters

forumIdstringrequired

The id of the forum

Query parameters

pageinteger | nullableoptional

The page number in a paginated set of results

limitinteger | nullableoptional

The limit of results to be returned per page

name[eq]stringoptional

Search Topic with a specified name

name[contains]stringoptional

Search Topic that contains this value in his name

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/topics'

200

400

200

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

Topics returned successfully

Récupérer un sujet

get

Get a topic

Path parameters

forumIdstringrequired

The id of the forum

topicIdstringrequired

The id of the topic

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/topics/{topicId}'

200

400

404

200

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

Topic found and returned successfully

Modifier un sujet

put

Update a topic

Path parameters

forumIdstringrequired

The id of the forum

topicIdstringrequired

The id of the topic

Body

namestringoptional

Name of the topic

contentstringoptional

Content of the topic

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/topics/{topicId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "content": "text"
  }'

200

400

404

200

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

Topic successfully updated

Supprimer un sujet

delete

Delete a topic

Path parameters

forumIdstringrequired

The id of the forum

topicIdstringrequired

The id of the topic

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/topics/{topicId}'

204

400

404

204

No body

Topic successfully deleted

Créer un sujet

post

Create a topic

Path parameters

forumIdstringrequired

The id of the forum

Body

namestringrequired

Name of the topic

contentstringoptional

Content of the topic (in Markdown)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/topics' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "content": "text"
  }'

201

400

201

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

Topic has been successfully created

Créer plusieurs sujets

post

Create multiple topics

Path parameters

forumIdstringrequired

ID of the forum

Body

namestringrequired

Name of the topic

contentstringoptional

Content of the topic (in Markdown)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/forums/{forumId}/topics~bulkCreate' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "name": "text",
      "content": "text"
    }
  ]'

201

400

413

201

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

Topics has been successfully created