[API] Cleaner way to create a tag?

Right now, in order to create a tag with the API, I create a temporary topic with the new tag, then delete the temporary topic. Is there a cleaner way?

I don’t know, but a slightly less painful solution would be to create a post in the staff category (where Assets for site design is) and just add the new tags there.

The reason is that you want to create a bunch of tags so that users can use them in the future, but your community doesn’t yet have posts with those tags?

Thanks @pfaffman.

You mean manually adding the new tag? Or is it possible to use the “Update a single topic” API to add a tag to an existing topic? But in that case I would have to store the topic id, which is painful…

I guess this would be a legit use case. But mine is less legit: I use tags to store metadata (object ids from an external app).

Yeah, that’s not a good idea, especially if each tag is only used once.

You should either have a separate database mapping the external IDs to Discourse topic IDs, or write a plugin and use topic custom fields (this is a problem since there’s no existing mechanism to deliver these to the client, I think).

Another solution is to store the value in the post text.

Since there is a legit use case, I believe adding a “new tag” API in the future would be a plus.

I can feel the danger of using tags the way I do. But as I need to display, in Discourse, a list of the topics that relate to a specific external object, the “tags.show” route seems the only way…

Well, what are the external objects? How many topics will one get? will a topic relate to multiple of these things?

You may be able to get away with using search.

The external objects are document subsections. One topic relates to one and only one subsection. A minimum guess is: 100 documents x 100 subsections per document = 10,000 subsections = 10,000 tags in a single Discourse instance. I know this is dangerous, but since I’m in the prototype phase, tags are good enough for me.

Now I didn’t think about the search page before… I’ve just done some tests, but sadly, the results are not formatted like a topic list (with the ‘Replies’, ‘Views’ and ‘Activity’ columns). I guess a “topics only” checkbox that turns the result page into a standard Discourse topic list would be exactly what I need. :slight_smile:

Consider not pre-creating that many topics - there’s often not much to discuss about the Bibliography. You can have a small service that takes a document & subsection ID and redirects you to either the existing topic or opens the composer pre-filled with the document link, subsection ID, etc.

title: Procedures for Smelling, section Keyboards
body: <https://link.to/document/1234#sec-26>

[write your text here]

lookup key: DISCUSS_1234_26

Then it polls /latest.json for new topics and checks them for the magic ID reference phrase I put in on the last line of the example.

Yes, I already have something like this. I don’t create the subsection tags beforehand when a document is created. I’ve changed the “tag not found” page of a subsection so that it looks like an empty topic list with a “New Topic” button at the top. When user clicks the button, I create the tag on the fly using the API and open the composer pre-filled with the generated tag.

Да, есть: создайте группу тегов, заполненную нужным вам тегом (см. API здесь).

Указанный выше метод создания тега через API (путем создания группы тегов) имеет один недостаток: он работает только для администраторов.

И ещё один способ создания тегов через API (но всё ещё только для администраторов): недокументированный эндпоинт /tags/upload.json, используемый в меню Upload Tags. Используйте его следующим образом:

const tags = ['tag1', 'tag2']
const file = new Blob([tags.join('\n')], { type: 'text/plain' })
const formData = new FormData()
formData.append('file', file)
$.ajax({
  type: 'POST',
  url: '/tags/upload.json',
  data: formData,
  contentType: false,
  processData: false
})

Если я планирую иметь тысячи тегов, всё ещё стоит ли использовать этот обходной путь — группу для каждого тега? Насколько группы тегов манёвренны по сравнению с тегами?

Если да, то это решает мою непосредственную проблему. Если нет, то я бы попытался избежать дублирования (тега + группы тегов для одного тега).

Извините, я не знаю.

Кажется, я помню, что API позволяет за одну операцию создавать несколько тегов в одной группе.

Спасибо. Да, это позволяет создавать несколько тегов в одной группе, но только при создании. Мы можем обновлять, но для этого мне нужно получить группу, добавить к ней данные, а затем отправить обратно. Эндпоинта для добавления нет.

Что касается второй идеи, которую вы предложили, с эндпоинтом /tags/upload.json.

Я нашел кнопку загрузки в интерфейсе. Я создал CSV-файл, который там работает нормально. Но я не могу заставить его работать в Postman или на Go (если вы знакомы, я использовал csv.NewWriter).

Есть какие-то идеи?

Извините, я не знаю, как создать и отправить blob с помощью этих инструментов.

Узнал, как это сделать.

Если кому-то нужно, напишите мне. Я не публикую это здесь, потому что это длинно и, скорее всего, неактуально для 99,99 % сообщества.