J’utilise l’API Discourse pour extraire des messages d’un forum. J’ai besoin d’aide pour comprendre la signification des champs renvoyés par l’API. Par exemple, le champ post_type dans chaque post est un nombre. Quelles sont les valeurs valides et que signifient-elles ? De même, l’id sous actions_summary est un nombre. Il existe d’autres champs tels que reads, score, etc., dont je ne suis pas certain. Des pistes sur l’endroit où je pourrais obtenir ces informations ? Merci !
1 « J'aime »
Si vous avez installé le plugin Data Explorer sur votre site, vous pouvez obtenir des détails sur les codes numériques en passant la souris sur les entrées :
Par exemple, survoler le champ posts post_type affiche les valeurs suivantes :
- regular : 1
- action de modérateur : 2
- petite action : 3
- whisper : 4
À part le Data Explorer, le seul endroit que je connaisse pour trouver ces informations est dans le code de Discourse. Par exemple, pour connaître la signification de chaque action_type de la table user_actions, saisissez UserAction.types dans la console Rails. Cela renvoie les valeurs suivantes :
{:like=>1, :was_liked=>2, :bookmark=>3, :new_topic=>4, :reply=>5, :response=>6, :mention=>7, :quote=>9, :edit=>11, :new_private_message=>12, :got_private_message=>13, :solved=>15, :assigned=>16}
3 « J'aime »
Merci @simon ! C’est une façon intéressante d’obtenir ces informations. J’ai fait quelques recherches basées sur vos suggestions et j’ai trouvé ce bout de code pour user_actions, mais je n’ai rien trouvé de similaire pour post_type après de nombreuses recherches. J’espérais que chaque champ renvoyé par l’API soit documenté quelque part, du moins pour les champs importants qui ont une sémantique significative.
C’est compréhensible. Il existe cependant un code similaire. Il se trouve ici : discourse/app/models/post.rb at main · discourse/discourse · GitHub. La structure de la base de données Discourse est très cohérente. J’espère que cela compense l’absence de documentation.
Je ne suis pas certain que chaque champ renvoyé par l’API sera documenté, mais il me semble important de documenter les différents endroits où des codes numériques sont renvoyés. Voici des exemples :
Post.typesUserAction.typesNotification.typesNotificationLevels.allUserOption.email_level_types
Si nous procédons à cela, je ne suis pas sûr de savoir où serait le meilleur endroit pour cette documentation. Peut-être sur https://docs.discourse.org/, mais il est possible que des problèmes techniques se posent pour le faire.
3 « J'aime »
Merci @simon ! Oui, répertorier les noms anglais/les descriptions en une ligne pour les codes numériques serait très utile. Y a-t-il un endroit où je peux faire une demande à ce sujet ?
1 « J'aime »
Je suis d’accord : ces champs doivent être documentés. Je vais me charger de ce sujet et m’assurer qu’il sera traité.
3 « J'aime »