[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?

4 إعجابات

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.

5 إعجابات

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.

إعجاب واحد (1)

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.

4 إعجابات

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.

Yes there is: create a tag group populated with the tag you want to create (see the API here).

5 إعجابات

The above method to create a tag with the API (by creating a tag group) has one drawback: it works only if you’re an admin.

إعجاب واحد (1)

وهناك طريقة أخرى لإنشاء الوسوم عبر واجهة برمجة التطبيقات (لكنها متاحة للمسؤولين فقط): الواجهة غير الموثقة /tags/upload.json، والتي تُستخدم من خلال قائمة رفع الوسوم. استخدمها على النحو التالي:

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
})
إعجاب واحد (1)

إذا كنت تخطط لاستخدام آلاف الوسوم، فهل لا يزال من الجيد استخدام هذه الحيلة، أي إنشاء مجموعة لكل وسم؟ هل مجموعات الوسوم مرنة مثل الوسوم نفسها؟

إذا كانت كذلك، فستحل مشكلتي المباشرة. أما إذا لم تكن كذلك، فسأحاول تجنب التكرار (الوسم + مجموعة الوسوم لوسم واحد فقط).

آسف، لا أعرف.

يبدو أنني أتذكر أن واجهة البرمجة (API) تسمح بإنشاء وسوم متعددة في مجموعة واحدة في عملية واحدة.

شكرًا لك. نعم، يتيح لنا إنشاء وسوم متعددة في نفس المجموعة، لكن فقط أثناء الإنشاء. يمكننا التحديث، لكنني بحاجة لاستعادة المجموعة أولاً، ثم إضافة البيانات إليها، ثم إعادة إرسالها. لا توجد نقطة نهاية مخصصة للإضافة.

بشأن الفكرة الثانية التي اقترحتها، وهي تلك المتعلقة بنقطة النهاية /tags/upload.json.

وجدت زر الرفع في الواجهة. لقد أنشأت ملف CSV يعمل بشكل جيد هناك، لكنني لا أستطيع جعله يعمل في Postman أو في Go (إذا كنت على دراية، فقد استخدمت csv.NewWriter).

هل لديك أي أفكار؟

آسف، لا أعرف كيفية إنشاء ونشر كائن (blob) باستخدام هذه الأدوات.

تمكنت من معرفة كيفية القيام بذلك.

إذا كان أي شخص بحاجة إلى ذلك، فاتصل بي. أنا لا أنشره هنا لأنه طويل وربما لا يهم 99.99% من المجتمع.